QueryCriteria
Bounding box of the search area as integer indexes or model aligned coordinates. If not provided, this is set to the entire block model.
If using integer indexes, they must be >=
zero and <=
the number of blocks - 1.
For example, if a block model has:
n_blocks: { nx: 10, ny: 10, nz: 10 }
then i_max, j_max, and k_max must all be >=
0 and <=
9.
If using model aligned coordinates, that is, rotated by the same scheme as the block model, centroids that are
encapsulated by the bounding box will be selected. A side effect of this behaviour is a bounding box with x, y, z
min-max can exceed the model along any axis.
Minimum and maximum values for the i
column in the file
Maximum value for the column
Minimum value for the column
Minimum and maximum values for the j
column in the file
Maximum value for the column
Minimum value for the column
Minimum and maximum values for the k
column in the file
Maximum value for the column
Minimum value for the column
Minimum and maximum values for the x
column in the file
Maximum value for the column
Minimum value for the column
Minimum and maximum values for the y
column in the file
Maximum value for the column
Minimum value for the column
Minimum and maximum values for the z
column in the file
Maximum value for the column
Minimum value for the column
Example: ["*"]
List of columns, in addition to the "geometry" columns, that will be included in the output file.
The columns
field supports selecting columns by either their title or ID, and can also include a wildcard ("*"
) placeholder, which will expand to all user columns, ordered alphabetically by title in a case-insensitive manner.
Please note that the wildcard does not cover the system column version_id
. To include version_id
in the output file, it must also be explicitly specified in the columns
field alongside the wildcard.
The order of columns in the output file will match the order in the columns
field. Columns that are part of the initial "geometry" columns will be ignored if specified.
"indices"
Determines whether the blocks in the output file will be primarily identified by their coordinates or their block indices.
If geometry_columns
is set to "indices" (the default), then the first columns in the output file will be i
, j
, k
followed by the sub-block index columns (if applicable).
If geometry_columns
is set to "coordinates", then the output file will contain the columns x
, y
, z
for regular block models and x
, y
, z
, dx
, dy
, dz
for sub-blocked block models. These columns are referred to as the "geometry" columns, and will appear before any others columns specified in the columns
field.
Format of the output file
"name"
Header values within the output file for non-system columns, either the column's name or UUID
true
Specifies whether or not the output query file should exclude rows where all values for queried user columns are null.
"parquet"
Apache Parquet file
"name"
Header values within the output file for non-system columns, either the column's name or UUID
","
Delimiter between values
true
Specifies whether or not the output query file should exclude rows where all values for queried user columns are null.
"csv"
CSV file
Version UUID of the version of the block model to query, or the latest version if not provided