db.schemas

emtellipro.db.schemas

This module contains schemas.

Subpackages

  • legacy - Module defining base functions and classes for implementing a schema

Submodules

  • schema - Module defining base functions and classes for implementing a schema
  • insert - This module contains functions that help with inserting the appropriate number…
  • util - Shared utilities for defining schemas.

Module Contents

Functions

NameDescription
available_schemasReturn all schema names that can be used.
load_schemaLoad the schema for a given name.

Data

__all__

API

emtellipro.db.schemas.__all__

emtellipro.db.schemas.__all__

Value: ['SchemaManifest', 'SaveDocument', 'load_schema']

emtellipro.db.schemas.available_schemas

emtellipro.db.schemas.available_schemas() -> set[str]

Return all schema names that can be used.

Return type: set[str]

emtellipro.db.schemas.load_schema

emtellipro.db.schemas.load_schema(name: str | emtellipro.db.schemas.schema.SchemaManifest)

Load the schema for a given name.

Parameters:

name
str | emtellipro.db.schemas.schema.SchemaManifest

The name of the schema. This can be hypehated or snake-case, and will be normalized as appropriate.

If this is already a schema object, it will be returned.