client.schema

Client for interacting with the schema service.

Methods:

Name	Description
get_schemas	Get the available schema types
schema_definition	Get the definition of a specified schema_type
schema_definition_all	Get the definition of all schema_types
schema_definition_multi	Get the definition of multiple schema_types

Attributes:

Name	Type	Description
server_version	Optional[Version]	The version of the service running on the remote server. Note that this

server_version: Optional[Version] property

The version of the service running on the remote server. Note that this refers to the software running on the server and has nothing to do with the version of the datastack itself.

get_schemas()

Get the available schema types

Returns:

Type	Description
list	List of schema types available on the Schema service.

schema_definition(schema_type)

Get the definition of a specified schema_type

Parameters:

Name	Type	Description	Default
schema_type	str	Name of a schema_type	required

Returns:

Type	Description
json	Schema definition

schema_definition_all()

Get the definition of all schema_types

Returns:

Type	Description
dict	Dictionary of schema definitions. Keys are schema names, values are definitions.

schema_definition_multi(schema_types)

Get the definition of multiple schema_types

Parameters:

Name	Type	Description	Default
schema_types	list	List of schema names	required

Returns:

Type	Description
dict	Dictionary of schema definitions. Keys are schema names, values are definitions.