Module datatap.api.entities.database

Expand source code
from __future__ import annotations
from typing import List, overload

from datatap.utils import basic_repr

from .repository import Repository
from ..endpoints import ApiEndpoints
from ..types import JsonDatabase, JsonDatabaseOptions

class Database:
    """
    Represents a database. This database could either be the public database,
    or a user's private database that they have connected to the dataTap
    platform.

    This class provides utilites for viewing and updating the database's
    configuration, as well as inspecting its contents.
    """
    _endpoints: ApiEndpoints

    uid: str
    """
    The UID of this database.
    """

    name: str
    """
    The name of this database.
    """

    connection_options: JsonDatabaseOptions
    """
    How this database is configured. Sensitive details, such as database
    credentials, are omitted.
    """

    @staticmethod
    def from_json(endpoints: ApiEndpoints, json: JsonDatabase) -> Database:
        """
        Creates a `Database` from a `JsonDatabase`.
        """
        return Database(
            endpoints,
            uid = json["uid"],
            name = json["name"],
            connection_options = json["connectionOptions"]
        )

    def __init__(self, endpoints: ApiEndpoints, uid: str, *, name: str, connection_options: JsonDatabaseOptions):
        self._endpoints = endpoints
        self.uid = uid
        self.name = name
        self.connection_options = connection_options

    def get_repository_list(self) -> List[Repository]:
        """
        Returns a list of all `Repository`s that are stored in this database.
        """
        return [
            Repository.from_json(self._endpoints, self.uid, repository_json)
            for repository_json in self._endpoints.repository.list(self.uid)
        ]


    @overload
    def get_repository(self, slug: str) -> Repository: ...
    @overload
    def get_repository(self, namespace: str, name: str) -> Repository: ...
    def get_repository(self, *args: str) -> Repository:
        """
        Queries a `Repository` by its namespace and name, or via its slug (namespace/name).
        """
        if len(args) == 1:
            namespace, name = args[0].split("/")
        else:
            namespace, name = args

        return Repository.from_json(self._endpoints, self.uid, self._endpoints.repository.query(self.uid, namespace, name))

    def __repr__(self):
        return basic_repr("Database", self.uid, name = self.name)

Classes

class Database (endpoints: ApiEndpoints, uid: str, *, name: str, connection_options: JsonDatabaseOptions)

Represents a database. This database could either be the public database, or a user's private database that they have connected to the dataTap platform.

This class provides utilites for viewing and updating the database's configuration, as well as inspecting its contents.

Expand source code
class Database:
    """
    Represents a database. This database could either be the public database,
    or a user's private database that they have connected to the dataTap
    platform.

    This class provides utilites for viewing and updating the database's
    configuration, as well as inspecting its contents.
    """
    _endpoints: ApiEndpoints

    uid: str
    """
    The UID of this database.
    """

    name: str
    """
    The name of this database.
    """

    connection_options: JsonDatabaseOptions
    """
    How this database is configured. Sensitive details, such as database
    credentials, are omitted.
    """

    @staticmethod
    def from_json(endpoints: ApiEndpoints, json: JsonDatabase) -> Database:
        """
        Creates a `Database` from a `JsonDatabase`.
        """
        return Database(
            endpoints,
            uid = json["uid"],
            name = json["name"],
            connection_options = json["connectionOptions"]
        )

    def __init__(self, endpoints: ApiEndpoints, uid: str, *, name: str, connection_options: JsonDatabaseOptions):
        self._endpoints = endpoints
        self.uid = uid
        self.name = name
        self.connection_options = connection_options

    def get_repository_list(self) -> List[Repository]:
        """
        Returns a list of all `Repository`s that are stored in this database.
        """
        return [
            Repository.from_json(self._endpoints, self.uid, repository_json)
            for repository_json in self._endpoints.repository.list(self.uid)
        ]


    @overload
    def get_repository(self, slug: str) -> Repository: ...
    @overload
    def get_repository(self, namespace: str, name: str) -> Repository: ...
    def get_repository(self, *args: str) -> Repository:
        """
        Queries a `Repository` by its namespace and name, or via its slug (namespace/name).
        """
        if len(args) == 1:
            namespace, name = args[0].split("/")
        else:
            namespace, name = args

        return Repository.from_json(self._endpoints, self.uid, self._endpoints.repository.query(self.uid, namespace, name))

    def __repr__(self):
        return basic_repr("Database", self.uid, name = self.name)

Class variables

var connection_optionsJsonDatabaseOptionsDirect

How this database is configured. Sensitive details, such as database credentials, are omitted.

var name : str

The name of this database.

var uid : str

The UID of this database.

Static methods

def from_json(endpoints: ApiEndpoints, json: JsonDatabase) ‑> Database

Creates a Database from a JsonDatabase.

Expand source code
@staticmethod
def from_json(endpoints: ApiEndpoints, json: JsonDatabase) -> Database:
    """
    Creates a `Database` from a `JsonDatabase`.
    """
    return Database(
        endpoints,
        uid = json["uid"],
        name = json["name"],
        connection_options = json["connectionOptions"]
    )

Methods

def get_repository(self, *args: str) ‑> Repository

Queries a Repository by its namespace and name, or via its slug (namespace/name).

Expand source code
def get_repository(self, *args: str) -> Repository:
    """
    Queries a `Repository` by its namespace and name, or via its slug (namespace/name).
    """
    if len(args) == 1:
        namespace, name = args[0].split("/")
    else:
        namespace, name = args

    return Repository.from_json(self._endpoints, self.uid, self._endpoints.repository.query(self.uid, namespace, name))
def get_repository_list(self) ‑> List[Repository]

Returns a list of all Repositorys that are stored in this database.

Expand source code
def get_repository_list(self) -> List[Repository]:
    """
    Returns a list of all `Repository`s that are stored in this database.
    """
    return [
        Repository.from_json(self._endpoints, self.uid, repository_json)
        for repository_json in self._endpoints.repository.list(self.uid)
    ]