Note
This documentation is for a prior release of Kinetica. For the latest documentation, click here.
URL: http://<db.host>:<db.port>/alter/table/metadata
Updates (adds or changes) metadata for tables. The metadata key and values must both be strings. This is an easy way to annotate whole tables rather than single records within tables. Some examples of metadata are owner of the table, table creation timestamp etc.
Input Parameter Description
| Name | Type | Description |
|---|---|---|
| table_names | array of strings | Names of the tables whose metadata will be updated, in [schema_name.]table_name format, using standard name resolution rules. All specified tables must exist, or an error will be returned. |
| metadata_map | map of string to strings | A map which contains the metadata of the tables that are to be updated. Note that only one map is provided for all the tables; so the change will be applied to every table. If the provided map is empty, then all existing metadata for the table(s) will be cleared. |
| options | map of string to strings | Optional parameters. The default value is an empty map ( {} ). |
Output Parameter Description
The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| status | String | 'OK' or 'ERROR' | ||||||||||||
| message | String | Empty if success or an error message | ||||||||||||
| data_type | String | 'alter_table_metadata_response' or 'none' in case of an error | ||||||||||||
| data | String | Empty string | ||||||||||||
| data_str | JSON or String | This embedded JSON represents the result of the /alter/table/metadata endpoint:
Empty string in case of an error. |
