Class SchemaApiService

JS API for the Schema Service Deephaven schema documentation

Hierarchy

SchemaApiService

Index

Constructors

Properties

Methods

checkTableNamesExist deleteSchema getSchemaXml getTableNames reloadTable saveSchemaXml getInstance

Constructors

`Protected` constructor

new SchemaApiService(): SchemaApiService
Returns SchemaApiService

Properties

`Static` `Readonly` NAME

NAME: string

The name of the Schema API Service. Used by the client for the name in the variable descriptor when calling getObject from the core connection.

`Static` `Readonly` TYPE

TYPE: string

The type of the Schema API Service. Used by the client for the type in the variable descriptor when calling getObject from the core connection.

Methods

checkTableNamesExist

checkTableNamesExist(ids): Promise<string[]>
Checks if table names exist.
Parameters
- ids: string[]
  
  the ids to check in the format "namespace.tableName"
Returns Promise<string[]>
an array of the ids found to exist

deleteSchema

deleteSchema(namespace, tableName): Promise<void>
Deletes a schema from the Schema Service using the provided namespace and table name.
Parameters
- namespace: string
  
  the namespace of the schema
- tableName: string
  
  the table name of the schema
Returns Promise<void>
a promise that resolves on successful delete

getSchemaXml

getSchemaXml(namespace, tableName): Promise<string>
Gets the schema xml String for a given namespace and table name.
Parameters
- namespace: string
  
  the namespace of the schema
- tableName: string
  
  the table name of the schema
Returns Promise<string>
a Promise that resolves to the schema xml string for the given namespace and table name

getTableNames

getTableNames(namespace): Promise<string[]>
Gets table names for a namespace.
Parameters
- namespace: string
  
  the namespace for the table names
Returns Promise<string[]>
a promise that resolves to an array of table names

reloadTable

reloadTable(): Promise<void>
Requests the schema api service reload the schema table names table.

Returns Promise<void>
a promise that resolves on successful reload

saveSchemaXml

saveSchemaXml(xmlString, noCompile): Promise<void>
Saves a schema xml String to the Schema Service. Uses the namespace and table name from the xml.
Parameters
- xmlString: string
  
  the xml string for the schema to save
- noCompile: boolean
  
  indicates that the server should skip compiling loggers and listeners
Returns Promise<void>
a promise that resolves on successful save

`Static` getInstance

getInstance(object): SchemaApiService
Gets a new SchemaApiService instance. Used to get, save, and delete xml schemas.
Parameters
- object: WidgetExportedObject | Table | Widget | TotalsTable | TreeTable | PartitionedTable
  
  some instance that lives on the server to be connected to.
Returns SchemaApiService
a new JsSchemaApiService instance