grai_schemas
v1
metadata
nodes

NodeMetadataTypeLabels Objects

class NodeMetadataTypeLabels(Enum)

Class definition of NodeMetadataTypeLabels

Attributes:

  • generic - The literal "Generic
  • table - The literal "Table"
  • column - The literal "Column"
  • query - The literal "Query"
  • collection - The literal "Collection"

SourceType Objects

class SourceType(Enum)

Class definition of SourceType

Attributes:

  • database - todo

BaseNodeMetadataV1 Objects

class BaseNodeMetadataV1(GraiBaseModel)

Class definition of BaseNodeMetadataV1

Attributes:

  • type - Object type of the Metadata e.g. NodeV1, EdgeV1, etc.
  • version - Schema version of the metadata
  • node_type - The type of node e.g. Table, Column, etc.
  • node_attributes - Attributes specific to the node type
  • tags - Tags associated with the node

MalformedNodeMetadataV1 Objects

class MalformedNodeMetadataV1(MalformedMetadata, BaseNodeMetadataV1)

Class definition of MalformedNodeMetadataV1

Attributes:

  • node_type - The literal "Malformed"
  • node_attributes - Attributes specific to the node type

node_type

type: ignore

node_attributes

type: ignore

GenericNodeMetadataV1 Objects

class GenericNodeMetadataV1(BaseNodeMetadataV1)

Class definition of GenericNodeMetadataV1

Attributes:

  • node_type - The literal "Generic"
  • node_attributes - Attributes specific to the node type

ColumnAttributes Objects

class ColumnAttributes(GenericAttributes)

Class definition of ColumnAttributes

Attributes:

  • version - Schema version of the metadata
  • data_type - The data type of the column
  • default_value - The default value of the column
  • is_nullable - Whether values in the column is nullable
  • is_unique - Whether values in the column are unique
  • is_primary_key - Whether the column is a primary key

data_type

This will need to be standardized

ColumnMetadata Objects

class ColumnMetadata(BaseNodeMetadataV1)

Class definition of ColumnMetadata

Attributes:

  • node_type - The type of node e.g. Table, Column, etc.
  • node_attributes - Attributes specific to the node type

TableAttributes Objects

class TableAttributes(GenericAttributes)

Class definition of TableAttributes

Attributes:

  • version - Schema version of the metadata

TableMetadata Objects

class TableMetadata(BaseNodeMetadataV1)

Class definition of TableMetadata

Attributes:

  • node_type - The type of node e.g. Table, Column, etc.
  • node_attributes - Attributes specific to the node type

QueryAttributes Objects

class QueryAttributes(GenericAttributes)

Class definition of QueryAttributes

Attributes:

  • version - Schema version of the metadata

QueryMetadata Objects

class QueryMetadata(BaseNodeMetadataV1)

Class definition of QueryMetadata

Attributes:

  • node_type - The type of node e.g. Table, Column, etc.
  • node_attributes - Attributes specific to the node type

CollectionMetadata Objects

class CollectionMetadata(BaseNodeMetadataV1)

Class definition of CollectionMetadata

Attributes:

  • node_type - The type of node e.g. Table, Column, etc.
  • node_attributes - Attributes specific to the node type