Package com.illumon.iris.db.schema

Interface SchemaServiceUtilLayer

All Superinterfaces:

AutoCloseable, NamedImplementation, SchemaService

All Known Implementing Classes:

SchemaServiceEtcdImpl, SchemaServiceKvImpl, SchemaServiceLegacyTransientImpl

public interface SchemaServiceUtilLayer
extends SchemaService

This implements "class" functionality that is independent of the persistence implementation. That is, methods that could as well be static utilities.

NB: This is a Deephaven internal implementation class and it is subject to change. Do not use this class directly.

Nested Class Summary

Nested classes/interfaces inherited from interface com.illumon.iris.db.schema.SchemaService

SchemaService.Delegating

Method Summary

Modifier and Type	Method	Description
default org.jdom2.Element	asElement(Schema schema)
default SchemaXml	asSchemaXml(Schema schema)
default SchemaXml	asSchemaXml(TableDefinitionSchema schema)
default MutableSchema	fromDefinition(TableDefinition sourceDefinition, String namespace, String tableName, int storageType, NamespaceSet namespaceSet, boolean useNanosecondTimePrecision)	Create a MutableSchema that supports SchemaXml from a TableDefinition, using the specified namespace, table name, storage type and NamespaceSet.
default SchemaXml	fromElement(org.jdom2.Element elem)	Create a Schema that supports SchemaXml from an input Element.

Methods inherited from interface com.illumon.util.type.NamedImplementation

getImplementationName

Methods inherited from interface com.illumon.iris.db.schema.SchemaService

about, addSchema, addSchema, addSchema, addSchema, authenticate, authenticate, authenticate, close, containsNamespace, containsNamespace, containsSchema, createNamespace, createNamespace, createNamespace, deleteSchema, deleteSchema, deleteSchema, deleteSchema, fromDefinition, fromDefinition, fromDefinition, fromDefinition, getAllSchemas, getLatestSchema, getLatestSchemaXml, getLatestTableDefinition, getLatestTableDefinitionRequired, getLatestTableDefinitionSchema, getNamespaceSet, getSchema, getSchema, getSchemas, getSchemas, getSchemasForNamespaceSet, initializationStage, listAllTables, listNamespaces, listNamespaces, listNamespaces, listNamespaces, listNamespaces, listTableNames, listTableNames, removeNamespace, removeNamespace, shutdown, updateSchema, updateSchema, updateSchema, updateSchema

Method Details

fromDefinition

@NotNull default MutableSchema fromDefinition(@NotNull TableDefinition sourceDefinition, @NotNull String namespace, @NotNull String tableName, int storageType, @NotNull NamespaceSet namespaceSet, boolean useNanosecondTimePrecision) throws SchemaValidationException

Description copied from interface: SchemaService

Create a MutableSchema that supports SchemaXml from a TableDefinition, using the specified namespace, table name, storage type and NamespaceSet. Values of namespace, table name, storage type and Namespace set from the input definition are not used.

Specified by:

fromDefinition in interface SchemaService

Parameters:

sourceDefinition - create a schema based on this table definition

namespace - the namespace of the new schema

tableName - the table name of the new schema

storageType - the storage type of the table

namespaceSet - the namespace set for the schema

useNanosecondTimePrecision - whether to set nanosecond time precision for DateTime columns

Returns:

a new MutableSchema.

Throws:

SchemaValidationException - if there was a problem creating the new schema.

fromElement

@NotNull default SchemaXml fromElement(org.jdom2.Element elem) throws SchemaValidationException

Description copied from interface: SchemaService

Create a Schema that supports SchemaXml from an input Element. The input element will be validated.

Specified by:

fromElement in interface SchemaService

Parameters:

elem - the element to create the schema from

Returns:

a new Schema

Throws:

SchemaValidationException - if the input element is not a properly structured Schema element

asElement

default org.jdom2.Element asElement(Schema schema)

Specified by:

asElement in interface SchemaService

asSchemaXml

default SchemaXml asSchemaXml(Schema schema)

Specified by:

asSchemaXml in interface SchemaService

asSchemaXml

default SchemaXml asSchemaXml(TableDefinitionSchema schema)