API
- class materializationengine.blueprints.client.api.DatastackMetadata(api=None, *args, **kwargs)[source]
Bases:
Resource- get(datastack_name: str)[source]
get materialized metadata for all valid versions :param datastack_name: datastack name :type datastack_name: str
- Returns:
list of metadata dictionaries
- Return type:
list
- methods: Optional[List[str]] = {'GET'}
A list of methods this view can handle.
- class materializationengine.blueprints.client.api.DatastackVersion(api=None, *args, **kwargs)[source]
Bases:
Resource- get(datastack_name: str, version: int)[source]
get version metadata
- Parameters:
datastack_name (str) – datastack name
version (int) – version number
- Returns:
metadata dictionary for this version
- Return type:
dict
- methods: Optional[List[str]] = {'GET'}
A list of methods this view can handle.
- class materializationengine.blueprints.client.api.DatastackVersions(api=None, *args, **kwargs)[source]
Bases:
Resource- get(datastack_name: str)[source]
get available versions
- Parameters:
datastack_name (str) – datastack name
- Returns:
list of versions that are available
- Return type:
list(int)
- methods: Optional[List[str]] = {'GET'}
A list of methods this view can handle.
- class materializationengine.blueprints.client.api.FrozenQuery(api=None, *args, **kwargs)[source]
Bases:
Resource- methods: Optional[List[str]] = {'POST'}
A list of methods this view can handle.
- post(datastack_name: str, version: int, target_datastack: str = None, target_version: int = None)[source]
endpoint for doing a query with filters and joins
- Parameters:
datastack_name (str) – datastack name
version (int) – version number
Payload: All values are optional. Limit has an upper bound set by the server. Consult the schema of the table for column names and appropriate values {
- “tables”:[[“table1”, “table1_join_column”],
[“table2”, “table2_join_column”]],
- “filter_out_dict”: {
- “tablename”:{
“column_name”:[excluded,values]
}
}, “offset”: 0, “limit”: 200000, “select_columns”: [
“column”,”names”
], “filter_in_dict”: {
- “tablename”:{
“column_name”:[included,values]
}
}, “filter_equal_dict”: {
- “tablename”:{
“column_name”:value
}
} “filter_spatial_dict”: {
- “tablename”:{
“column_name”:[[min_x,min_y,minz], [max_x_max_y_max_z]]
}
}
} :returns: a series of bytes that can be deserialized using pyarrow.deserialize :rtype: pyarrow.buffer
- class materializationengine.blueprints.client.api.FrozenTableCount(api=None, *args, **kwargs)[source]
Bases:
Resource- get(datastack_name: str, version: int, table_name: str, target_datastack: str = None, target_version: int = None)[source]
get annotation count in table
- Parameters:
datastack_name (str) – datastack name of table
version (int) – version of table
table_name (str) – table name
- Returns:
number of rows in this table
- Return type:
int
- methods: Optional[List[str]] = {'GET'}
A list of methods this view can handle.
- class materializationengine.blueprints.client.api.FrozenTableMetadata(api=None, *args, **kwargs)[source]
Bases:
Resource- get(datastack_name: str, version: int, table_name: str)[source]
get frozen table metadata
- Parameters:
datastack_name (str) – datastack name
version (int) – version number
table_name (str) – table name
- Returns:
dictionary of table metadata
- Return type:
dict
- methods: Optional[List[str]] = {'GET'}
A list of methods this view can handle.
- class materializationengine.blueprints.client.api.FrozenTableQuery(api=None, *args, **kwargs)[source]
Bases:
Resource- methods: Optional[List[str]] = {'POST'}
A list of methods this view can handle.
- post(datastack_name: str, version: int, table_name: str, target_datastack: str = None, target_version: int = None)[source]
endpoint for doing a query with filters
- Parameters:
datastack_name (str) – datastack name
version (int) – version number
table_name (str) – table name
Payload: All values are optional. Limit has an upper bound set by the server. Consult the schema of the table for column names and appropriate values {
- “filter_out_dict”: {
- “tablename”:{
“column_name”:[excluded,values]
}
}, “offset”: 0, “limit”: 200000, “select_columns”: [
“column”,”names”
], “filter_in_dict”: {
- “tablename”:{
“column_name”:[included,values]
}
}, “filter_equal_dict”: {
- “tablename”:{
“column_name”:value
}
- “filter_spatial_dict”: {
“tablename”: { “column_name”: [[min_x, min_y, min_z], [max_x, max_y, max_z]]
}
} :returns: a series of bytes that can be deserialized using pyarrow.deserialize :rtype: pyarrow.buffer
- class materializationengine.blueprints.client.api.FrozenTableVersions(api=None, *args, **kwargs)[source]
Bases:
Resource- get(datastack_name: str, version: int)[source]
get frozen tables
- Parameters:
datastack_name (str) – datastack name
version (int) – version number
- Returns:
list of frozen tables in this version
- Return type:
list(str)
- methods: Optional[List[str]] = {'GET'}
A list of methods this view can handle.