Note

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

/has/schema

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

Checks for the existence of a schema with the given name.

Input Parameter Description

NameTypeDescription
schema_namestringName of the schema to check for existence, in root, using standard name resolution rules.
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'has_schema_response' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

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

NameTypeDescription
schema_namestringValue of input parameter schema_name
schema_existsboolean

Indicates whether the schema exists or not. Possible values are:

  • true
  • false
infomap of string to stringsAdditional information.

Empty string in case of an error.