Items

Schema

class rapid.items.schema.Column(name: str, data_type: str, partition_index: Union[int, NoneType] = None, allow_null: bool = True, format: Union[str, NoneType] = None)

Bases: object

allow_null: bool = True

data_type: str

format: Optional[str] = None

name: str

partition_index: Optional[int] = None

to_dict()

class rapid.items.schema.Owner(name: str, email: str)

Bases: object

email: str

name: str

to_dict()

class rapid.items.schema.Schema(metadata: SchemaMetadata, columns: Union[List[Column], List[dict]])

Bases: object

are_columns_the_same(columns_b: Union[List[Column], List[dict]])

columns: List[Column]

create(rapid: Rapid)

metadata: SchemaMetadata

set_columns(columns: List[Column])

to_dict()

update(rapid: Rapid)

class rapid.items.schema.SchemaMetadata(domain: str, dataset: str, _sensitivity: rapid.items.schema.SensitivityLevel, owners: List[rapid.items.schema.Owner], version: Union[int, NoneType] = None, key_value_tags: Union[Dict[str, str], NoneType] = None, key_only_tags: Union[List[str], NoneType] = None)

Bases: object

dataset: str

domain: str

key_only_tags: Optional[List[str]] = None

key_value_tags: Optional[Dict[str, str]] = None

owners: List[Owner]

property sensitivity: str

to_dict()

version: Optional[int] = None

class rapid.items.schema.SensitivityLevel(value)

Bases: Enum

An enumeration.

PRIVATE = 'PRIVATE'

PROTECTED = 'PROTECTED'

PUBLIC = 'PUBLIC'

class rapid.items.schema.UpdateBehaviour(value)

Bases: Enum

An enumeration.

APPEND = 'APPEND'

OVERWRITE = 'OVERWRITE'