/create/schema

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/create/schema

Creates a SQL-style schema. Schemas are containers for tables and views. Multiple tables and views can be defined with the same name in different schemas.

Input Parameter Description

NameTypeDescription
schema_namestringName of the schema to be created. Has the same naming restrictions as tables.
optionsmap of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys)Parameter Description
no_error_if_exists

If true, prevents an error from occurring if the schema already exists. The default value is false. The supported values are:

  • true
  • false

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'create_schema_request' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

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

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

Empty string in case of an error.