cfxdb.globalschema

Classes

ActivationTokens	User activations (activation_oid -> activation).
GlobalSchema	Global (master node wide) database schema.
IndexActivationTokensByAuthidPubkey	Index of activation tokes by user authid and pubkey ((user_authid, user_pubkey) -> activation_oid).
IndexManagementRealmByName	Index of management realms by name (mrealm_name -> mrealm_oid).
IndexNodesByAuthid	Index of nodes by management realm and node authid ((mrealm_oid, authid) -> node_oid).
IndexNodesByPubkey	Index of nodes by node public key (node_pubkey -> node_oid).
IndexOrganizationsByName	Index of organizations by name (organization_name -> organization_oid).
IndexUsersByEmail	Index of users by email address (user_email -> user_oid).
IndexUsersByName	Index of users by name (user_name -> user_oid).
IndexUsersByPubkey	Index of users by pubkey (user_pubkey -> user_oid).
ManagementRealms	Management realm database configuration object (oid -> mrealm).
Nodes	Nodes paired with management realms (node_oid -> node).
Organizations	Organizations defined in this domain / master node (organization_oid -> organization).
UsageRecords	Usage metering records ((timestamp, usage_oid) -> usage_record).
UserMrealmRoles	User roles on management realms ((mrealm_oid, role_oid) -> role).
Users	Users registered in this domain / master node (user_oid -> user).

Module Contents

class ActivationTokens(slot=None, compress=None, marshal=None, unmarshal=None)

Bases: zlmdb.MapUuidCbor

User activations (activation_oid -> activation).

class GlobalSchema(db)

Bases: object

Global (master node wide) database schema.

activation_tokens: ActivationTokens

User activation tokens.

• Database table cfxdb.globalschema.ActivationTokens

static attach(db: zlmdb.Database) → object

Factory to create a schema from attaching to a database. The schema tables will be automatically mapped as persistant maps and attached to the database slots.

Parameters:

db – Database to which to attach this schema.

Returns:

Open database handle with attached schema, an instance of GlobalSchema.

db

idx_act_tokens_by_authid_pubkey: IndexActivationTokensByAuthidPubkey

Index on user activation tokens (by authid, pubkey).

• Database table cfxdb.globalschema.IndexActivationTokensByAuthidPubkey

idx_mrealms_by_name: IndexManagementRealmByName

Index on management realms (by name).

• Database table cfxdb.globalschema.IndexManagementRealmByName

idx_nodes_by_authid: IndexNodesByAuthid

Index on nodes (by authid).

• Database table cfxdb.globalschema.IndexNodesByAuthid

idx_nodes_by_pubkey: IndexNodesByPubkey

Index on nodes (by pubkey).

• Database table cfxdb.globalschema.IndexNodesByPubkey

idx_organizations_by_name: IndexOrganizationsByName

Index on organizations (by name).

• Database table cfxdb.globalschema.IndexOrganizationsByName

idx_users_by_email: IndexUsersByEmail

Index on users (by email).

• Database table cfxdb.globalschema.IndexUsersByEmail

idx_users_by_pubkey: IndexUsersByPubkey

Index on users (by pubkey).

• Database table cfxdb.globalschema.IndexUsersByPubkey

mrealms: ManagementRealms

Management realms.

• Database table cfxdb.globalschema.ManagementRealms

nodes: Nodes

Nodes.

• Database table cfxdb.globalschema.Nodes

organizations: Organizations

Organizations.

• Database table cfxdb.globalschema.Organizations

usage: UsageRecords

Usage metering records (by timestamp).

• Database table cfxdb.globalschema.UsageRecords

users: Users

Users.

• Database table cfxdb.globalschema.Users

users_mrealm_roles: UserMrealmRoles

User roles map (by mrealm_oid, user_oid to UserRoles).

• Database table cfxdb.globalschema.UserMrealmRoles

class IndexActivationTokensByAuthidPubkey(slot=None, compress=None)

Bases: zlmdb.MapStringUuid

Index of activation tokes by user authid and pubkey ((user_authid, user_pubkey) -> activation_oid).

class IndexManagementRealmByName(slot=None, compress=None)

Bases: zlmdb.MapStringUuid

Index of management realms by name (mrealm_name -> mrealm_oid).

class IndexNodesByAuthid(slot=None, compress=None)

Bases: zlmdb.MapUuidStringUuid

Index of nodes by management realm and node authid ((mrealm_oid, authid) -> node_oid).

class IndexNodesByPubkey(slot=None, compress=None)

Bases: zlmdb.MapStringUuid

Index of nodes by node public key (node_pubkey -> node_oid).

class IndexOrganizationsByName(slot=None, compress=None)

Bases: zlmdb.MapStringUuid

Index of organizations by name (organization_name -> organization_oid).

class IndexUsersByEmail(slot=None, compress=None)

Bases: zlmdb.MapStringUuid

Index of users by email address (user_email -> user_oid).

class IndexUsersByName(slot=None, compress=None)

Bases: zlmdb.MapStringUuid

Index of users by name (user_name -> user_oid).

class IndexUsersByPubkey(slot=None, compress=None)

Bases: zlmdb.MapStringUuid

Index of users by pubkey (user_pubkey -> user_oid).

class ManagementRealms(slot=None, compress=None, marshal=None, unmarshal=None)

Bases: zlmdb.MapUuidCbor

Management realm database configuration object (oid -> mrealm).

class Nodes(slot=None, compress=None, marshal=None, unmarshal=None)

Bases: zlmdb.MapUuidCbor

Nodes paired with management realms (node_oid -> node).

class Organizations(slot=None, compress=None, marshal=None, unmarshal=None)

Bases: zlmdb.MapUuidCbor

Organizations defined in this domain / master node (organization_oid -> organization).

class UsageRecords(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb.MapTimestampUuidFlatBuffers

Usage metering records ((timestamp, usage_oid) -> usage_record).

class UserMrealmRoles(slot=None, compress=None, marshal=None, unmarshal=None)

Bases: zlmdb.MapUuidUuidCbor

User roles on management realms ((mrealm_oid, role_oid) -> role).

class Users(slot=None, compress=None, marshal=None, unmarshal=None)

Bases: zlmdb.MapUuidCbor

Users registered in this domain / master node (user_oid -> user).