/drop/schema

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/drop/schema

Drops an existing SQL-style schema, specified in input parameter schema_name.

Input Parameter Description

NameTypeDescription
schema_namestringName of the schema to be dropped. Must be an existing schema.
optionsmap of string to strings

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

Supported Parameters (keys)Parameter Description
no_error_if_not_exists

If true and if the schema specified in input parameter schema_name does not exist, no error is returned. If false and if the schema specified in input parameter schema_name does not exist, then an error is returned. The default value is false. The supported values are:

  • true
  • false
cascade

If true, all tables within the schema will be dropped. If false, the schema will be dropped only if empty. 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'drop_schema_request' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

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

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

Empty string in case of an error.