dbrepo.core.api package

Submodules

dbrepo.core.api.dto module

class dbrepo.core.api.dto.CreateDatasource(*, name: str, type: str, access: str, url: str, basicAuth: bool, version: int, readOnly: bool, jsonData: dict | None = None, secureJsonData: dict | None = None, basicAuthUser: str | None = None)

Bases: BaseModel

access: str

basicAuth: bool

basicAuthUser: str | None

jsonData: dict | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str

readOnly: bool

secureJsonData: dict | None

type: str

url: str

version: int

class dbrepo.core.api.dto.CreateDatasourceRequest(*, database_internal_name: str, readonly: bool, type: str)

Bases: BaseModel

database_internal_name: str

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

readonly: bool

type: str

class dbrepo.core.api.dto.Datasource(*, uid: str, type: str, id: int | None = None, orgId: int | None = None, name: str | None = None, typeLogoUrl: str | None = None, access: str | None = None, url: str | None = None, user: str | None = None, basicAuth: bool | None = None, withCredentials: bool | None = None, isDefault: bool | None = None, version: int | None = None, readOnly: bool | None = None, jsonData: dict | None = None, secureJsonFields: dict | None = None, basicAuthUser: str | None = None, basicAuthPassword: str | None = None, password: str | None = None)

Bases: BaseModel

access: str | None

basicAuth: bool | None

basicAuthPassword: str | None

basicAuthUser: str | None

id: int | None

isDefault: bool | None

jsonData: dict | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None

orgId: int | None

password: str | None

readOnly: bool | None

secureJsonFields: dict | None

type: str

typeLogoUrl: str | None

uid: str

url: str | None

user: str | None

version: int | None

withCredentials: bool | None

class dbrepo.core.api.dto.Permission(*, permission: str)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

permission: str

class dbrepo.core.api.dto.User(*, id: str, username: str, roles: List[str])

Bases: BaseModel

id: str

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

roles: List[str]

username: str

dbrepo.core.api.exceptions module

exception dbrepo.core.api.exceptions.DashboardNotFound

Bases: Exception

The dashboard could not be found.

Module contents