Skip to main content
URL: http://<db.host>:<db.port>/alter/schema
Used to change the name of a SQL-style schema, specified in input parameter schema_name.

​
Input Parameter Description

​
schema_name
string
Name of the schema to be altered.
​
action
string
Modification operation to be applied.
  • add_comment: Adds a comment describing the schema.
  • rename_schema: Renames a schema to input parameter value. Has the same naming restrictions as tables.
​
value
string
The value of the modification, depending on input parameter action. For now the only value of input parameter action is rename_schema. In this case the value is the new name of the schema.
​
options
map of string to strings
Optional parameters.The default value is an empty map ( {} ).

​
Output Parameter Description

The Kinetica 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:
​
status
String
‘OK’ or ‘ERROR’
​
message
String
Empty if success or an error message
​
data_type
String
‘alter_schema_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/schema endpoint:Empty string in case of an error.