##############################################################################
#
# Crossbar.io Database
# Copyright (c) typedef int GmbH. Licensed under MIT.
#
##############################################################################
import zlmdb
from zlmdb import MapStringUuid, MapTimestampUuidFlatBuffers, MapUuidCbor, MapUuidStringUuid, MapUuidUuidCbor, table
from cfxdb.mrealm import ManagementRealm, Node
from cfxdb.usage import MasterNodeUsage
from cfxdb.user import ActivationToken, Organization, User, UserMrealmRole
__all__ = (
"ManagementRealms",
"IndexManagementRealmByName",
"Nodes",
"IndexNodesByPubkey",
"IndexNodesByAuthid",
"Users",
"IndexUsersByName",
"IndexUsersByPubkey",
"IndexUsersByEmail",
"UserMrealmRoles",
"ActivationTokens",
"IndexActivationTokensByAuthidPubkey",
"Organizations",
"IndexOrganizationsByName",
"UsageRecords",
"GlobalSchema",
)
@table("1219e71c-a62c-415a-bd15-ddf45e3a658b", marshal=ManagementRealm.marshal, parse=ManagementRealm.parse)
[docs]
class ManagementRealms(MapUuidCbor):
"""
Management realm database configuration object (``oid -> mrealm``).
"""
@table("1d2e8045-ea2b-4456-be4a-7a234d3622d6")
[docs]
class IndexManagementRealmByName(MapStringUuid):
"""
Index of management realms by name (``mrealm_name -> mrealm_oid``).
"""
@table("ae89d956-273a-4ce3-b63d-52b07ae35742", marshal=Node.marshal, parse=Node.parse)
[docs]
class Nodes(MapUuidCbor):
"""
Nodes paired with management realms (``node_oid -> node``).
"""
@table("1336c623-5f38-4397-ad5b-2e6b716b57b0")
[docs]
class IndexNodesByPubkey(MapStringUuid):
"""
Index of nodes by node public key (``node_pubkey -> node_oid``).
"""
@table("6d071a33-0577-4f72-a2e1-11182f60ab9c")
[docs]
class IndexNodesByAuthid(MapUuidStringUuid):
"""
Index of nodes by management realm and node authid (``(mrealm_oid, authid) -> node_oid``).
"""
@table("fa1ed0fc-304e-4f66-8092-d901df1735e4", marshal=User.marshal, parse=User.parse)
[docs]
class Users(MapUuidCbor):
"""
Users registered in this domain / master node (``user_oid -> user``).
"""
@table("aa2754e5-a859-4986-8749-1299828dc6e1")
[docs]
class IndexUsersByName(MapStringUuid):
"""
Index of users by name (``user_name -> user_oid``).
"""
@table("882a24e4-90cc-4823-94fe-c1d938daffe6")
[docs]
class IndexUsersByPubkey(MapStringUuid):
"""
Index of users by pubkey (``user_pubkey -> user_oid``).
"""
@table("933447a3-dd79-4599-bd9a-e0d88d9b84cb")
[docs]
class IndexUsersByEmail(MapStringUuid):
"""
Index of users by email address (``user_email -> user_oid``).
"""
@table("eccdfc57-5632-4ad4-9c2b-2ac11e9d389f", marshal=UserMrealmRole.marshal, parse=UserMrealmRole.parse)
[docs]
class UserMrealmRoles(MapUuidUuidCbor):
"""
User roles on management realms (``(mrealm_oid, role_oid) -> role``).
"""
@table("c968886e-a2e2-490c-bc2a-6b684c3130f6", marshal=ActivationToken.marshal, parse=ActivationToken.parse)
[docs]
class ActivationTokens(MapUuidCbor):
"""
User activations (``activation_oid -> activation``).
"""
@table("0f6a9014-2e39-4cfd-9f2b-f6ffd3d3deca")
[docs]
class IndexActivationTokensByAuthidPubkey(MapStringUuid):
"""
Index of activation tokes by user authid and pubkey (``(user_authid, user_pubkey) -> activation_oid``).
"""
@table("ae2fe53f-f8ec-4484-8a8f-cabdf1b38358", marshal=Organization.marshal, parse=Organization.parse)
[docs]
class Organizations(MapUuidCbor):
"""
Organizations defined in this domain / master node (``organization_oid -> organization``).
"""
@table("3fb82ab2-430d-43a1-8200-fcd6355d0410")
[docs]
class IndexOrganizationsByName(MapStringUuid):
"""
Index of organizations by name (``organization_name -> organization_oid``).
"""
@table("e38f7bf1-2514-400c-8c30-a979b2138503", build=MasterNodeUsage.build, cast=MasterNodeUsage.cast)
[docs]
class UsageRecords(MapTimestampUuidFlatBuffers):
"""
Usage metering records (``(timestamp, usage_oid) -> usage_record``).
"""
[docs]
class GlobalSchema(object):
"""
Global (master node wide) database schema.
"""
def __init__(self, db):
"""
Nodes.
* Database table :class:`cfxdb.globalschema.Nodes`
"""
[docs]
idx_nodes_by_pubkey: IndexNodesByPubkey
"""
Index on nodes (by pubkey).
* Database table :class:`cfxdb.globalschema.IndexNodesByPubkey`
"""
[docs]
idx_nodes_by_authid: IndexNodesByAuthid
"""
Index on nodes (by authid).
* Database table :class:`cfxdb.globalschema.IndexNodesByAuthid`
"""
[docs]
organizations: Organizations
"""
Organizations.
* Database table :class:`cfxdb.globalschema.Organizations`
"""
[docs]
idx_organizations_by_name: IndexOrganizationsByName
"""
Index on organizations (by name).
* Database table :class:`cfxdb.globalschema.IndexOrganizationsByName`
"""
"""
Users.
* Database table :class:`cfxdb.globalschema.Users`
"""
[docs]
idx_users_by_pubkey: IndexUsersByPubkey
"""
Index on users (by pubkey).
* Database table :class:`cfxdb.globalschema.IndexUsersByPubkey`
"""
[docs]
idx_users_by_email: IndexUsersByEmail
"""
Index on users (by email).
* Database table :class:`cfxdb.globalschema.IndexUsersByEmail`
"""
[docs]
activation_tokens: ActivationTokens
"""
User activation tokens.
* Database table :class:`cfxdb.globalschema.ActivationTokens`
"""
[docs]
idx_act_tokens_by_authid_pubkey: IndexActivationTokensByAuthidPubkey
"""
Index on user activation tokens (by authid, pubkey).
* Database table :class:`cfxdb.globalschema.IndexActivationTokensByAuthidPubkey`
"""
[docs]
mrealms: ManagementRealms
"""
Management realms.
* Database table :class:`cfxdb.globalschema.ManagementRealms`
"""
[docs]
idx_mrealms_by_name: IndexManagementRealmByName
"""
Index on management realms (by name).
* Database table :class:`cfxdb.globalschema.IndexManagementRealmByName`
"""
[docs]
users_mrealm_roles: UserMrealmRoles
"""
User roles map (by mrealm_oid, user_oid to UserRoles).
* Database table :class:`cfxdb.globalschema.UserMrealmRoles`
"""
"""
Usage metering records (by timestamp).
* Database table :class:`cfxdb.globalschema.UsageRecords`
"""
@staticmethod
[docs]
def 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.
:param db: Database to which to attach this schema.
:returns: Open database handle with attached schema, an instance of :class:`GlobalSchema`.
"""
schema = GlobalSchema(db)
# Organizations
#
schema.organizations = db.attach_table(Organizations)
schema.idx_organizations_by_name = db.attach_table(IndexOrganizationsByName)
schema.organizations.attach_index("idx1", schema.idx_organizations_by_name, lambda org: org.name)
# Users
#
schema.users = db.attach_table(Users)
schema.idx_users_by_pubkey = db.attach_table(IndexUsersByPubkey)
schema.users.attach_index("idx1", schema.idx_users_by_pubkey, lambda user: user.pubkey, nullable=True)
schema.idx_users_by_email = db.attach_table(IndexUsersByEmail)
schema.users.attach_index("idx2", schema.idx_users_by_email, lambda user: user.email, nullable=True)
schema.activation_tokens = db.attach_table(ActivationTokens)
schema.idx_act_tokens_by_authid_pubkey = db.attach_table(IndexActivationTokensByAuthidPubkey)
schema.activation_tokens.attach_index(
"idx1", schema.idx_act_tokens_by_authid_pubkey, lambda token: token.email + token.pubkey
)
# Management Realms
#
schema.mrealms = db.attach_table(ManagementRealms)
schema.idx_mrealms_by_name = db.attach_table(IndexManagementRealmByName)
schema.mrealms.attach_index("idx1", schema.idx_mrealms_by_name, lambda mrealm: mrealm.name)
schema.users_mrealm_roles = db.attach_table(UserMrealmRoles)
# Nodes
#
schema.nodes = db.attach_table(Nodes)
schema.idx_nodes_by_pubkey = db.attach_table(IndexNodesByPubkey)
schema.nodes.attach_index("idx1", schema.idx_nodes_by_pubkey, lambda node: node.pubkey)
schema.idx_nodes_by_authid = db.attach_table(IndexNodesByAuthid)
schema.nodes.attach_index(
"idx2", schema.idx_nodes_by_authid, lambda node: (node.mrealm_oid, node.authid), nullable=True
)
# Usage metering
#
schema.usage = db.attach_table(UsageRecords)
return schema