Module datatap.api.types.database

Expand source code
from typing import Union
from typing_extensions import Literal, TypedDict

class JsonDatabaseOptionsDirect(TypedDict):
    """
    Configuration options for a database that the server connects to directly.
    """
    kind: Literal["direct"]
    protocol: Union[Literal["neo4j"], Literal["neo4j+s"]]
    host: str
    port: int

JsonDatabaseOptions = Union[JsonDatabaseOptionsDirect]

class JsonDatabase(TypedDict):
    """
    The API type of a database.
    """
    uid: str
    name: str
    connectionOptions: JsonDatabaseOptions

Classes

class JsonDatabase (*args, **kwargs)

The API type of a database.

Expand source code
class JsonDatabase(TypedDict):
    """
    The API type of a database.
    """
    uid: str
    name: str
    connectionOptions: JsonDatabaseOptions

Ancestors

  • builtins.dict

Class variables

var connectionOptionsJsonDatabaseOptionsDirect
var name : str
var uid : str
class JsonDatabaseOptionsDirect (*args, **kwargs)

Configuration options for a database that the server connects to directly.

Expand source code
class JsonDatabaseOptionsDirect(TypedDict):
    """
    Configuration options for a database that the server connects to directly.
    """
    kind: Literal["direct"]
    protocol: Union[Literal["neo4j"], Literal["neo4j+s"]]
    host: str
    port: int

Ancestors

  • builtins.dict

Class variables

var host : str
var kind : Literal['direct']
var port : int
var protocol : Union[Literal['neo4j'], Literal['neo4j+s']]
class JsonDatabaseOptions (*args, **kwargs)

Configuration options for a database that the server connects to directly.

Expand source code
class JsonDatabaseOptionsDirect(TypedDict):
    """
    Configuration options for a database that the server connects to directly.
    """
    kind: Literal["direct"]
    protocol: Union[Literal["neo4j"], Literal["neo4j+s"]]
    host: str
    port: int

Ancestors

  • builtins.dict

Class variables

var host : str
var kind : Literal['direct']
var port : int
var protocol : Union[Literal['neo4j'], Literal['neo4j+s']]