data_grouping_configurations

Manages data grouping configurations on a table

---

create_table_grouping_configuration

Creates a new data grouping configuration on a table level
Source code

POST

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/groupings  

Parameters of this method are described below

Property name	Description	Data type	Required
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Request body

Description	Data type	Required
Data grouping configuration simplified model	DataGroupingConfigurationTrimmedModel

Usage examples

curl

curl -X POST http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/groupings^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"data_grouping_configuration_name\":\"sample_data_grouping\",\"spec\":{\"level_3\":{\"source\":\"column_value\",\"column\":\"sample_column\"}},\"can_edit\":true}"

---

delete_table_grouping_configuration

Deletes a data grouping configuration from a table
Source code

DELETE

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/groupings/{dataGroupingConfigurationName}  

Parameters of this method are described below

Property name	Description	Data type	Required
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
data_grouping_configuration_name	Data grouping configuration name	string

Usage examples

curl

curl -X DELETE http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/groupings/sample_data_grouping^
    -H "Accept: application/json"

---

get_table_grouping_configuration

Returns a model of the data grouping configuration
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/groupings/{groupingConfigurationName}  

Return value

Property name	Description	Data type
data_grouping_configuration_model		DataGroupingConfigurationModel

Parameters of this method are described below

Property name	Description	Data type	Required
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
grouping_configuration_name	Data grouping configuration name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/groupings/sample_data_grouping^
    -H "Accept: application/json"

---

get_table_grouping_configurations

Returns the list of data grouping configurations on a table
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/groupings  

Return value

Property name	Description	Data type
data_grouping_configuration_list_model		List[DataGroupingConfigurationListModel]

Parameters of this method are described below

Property name	Description	Data type	Required
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/groupings^
    -H "Accept: application/json"

---

set_table_default_grouping_configuration

Sets a table's grouping configuration as the default or disables data grouping
Source code

PATCH

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/groupings/setdefault  

Parameters of this method are described below

Property name	Description	Data type	Required
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
data_grouping_configuration_name	Data grouping configuration name or empty to disable data grouping	string

Usage examples

curl

curl -X PATCH http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/groupings/setdefault^
    -H "Accept: application/json"

---

update_table_grouping_configuration

Updates a data grouping configuration according to the provided model
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/groupings/{dataGroupingConfigurationName}  

Parameters of this method are described below

Property name	Description	Data type	Required
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
data_grouping_configuration_name	Data grouping configuration name	string

Request body

Description	Data type	Required
Data grouping configuration simplified model	DataGroupingConfigurationTrimmedModel

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/groupings/sample_data_grouping^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"data_grouping_configuration_name\":\"sample_data_grouping\",\"spec\":{\"level_3\":{\"source\":\"column_value\",\"column\":\"sample_column\"}},\"can_edit\":true}"