/alter/schema

URL: https://<aws.fqdn>/<aws.cluster.name>/gpudb-0/alter/schema

Used to change the name of a SQL-style schema, specified in input parameter schema_name.

Input Parameter Description

NameTypeDescription
schema_namestringName of the schema to be altered.
actionstring

Modification operation to be applied

Supported ValuesDescription
add_commentAdds a comment describing the schema
rename_schemaRenames a schema to input parameter value. Has the same naming restrictions as tables.
valuestringThe 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.
optionsmap of string to stringsOptional 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:

NameTypeDescription
statusString'OK' or 'ERROR'
messageStringEmpty if success or an error message
data_typeString'alter_schema_response' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

This embedded JSON represents the result of the /alter/schema endpoint:

NameTypeDescription
schema_namestringValue of input parameter schema_name.
infomap of string to stringsAdditional information.

Empty string in case of an error.