Note

This documentation is for a prior release of Kinetica. For the latest documentation, click here.

/drop/schema

URL: http://<db.host>:<db.port>/drop/schema

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

Input Parameter Description

Name

Type

Description

schema_name

string

Name of the schema to be dropped. Must be an existing schema.

options

map 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:

Name

Type

Description

status

String

'OK' or 'ERROR'

message

String

Empty if success or an error message

data_type

String

'drop_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 /drop/schema endpoint:

Name	Type	Description
schema_name	string	Value of input parameter schema_name.
info	map of string to strings	Additional information.

Empty string in case of an error.