DatabaseDataProvider - Провайдер для баз данных

class axipy.DatabaseDataProvider

Базовые классы: DataProvider

Базовый класс для провайдеров БД.

Свойства:

id

Идентификатор провайдера.

Методы:

create_open(*args, **kwargs)

Создает и открывает объект данных.

file_extensions()

Список поддерживаемых расширений файлов.

get_destination()

Создает назначение объекта данных.

get_source(host, db_name, user, password[, ...])

Создает описательную структуру для источника данных.

open(host, db_name, user, password[, port, ...])

Открывает объект данных.
create_open(*args, **kwargs)

Создает и открывает объект данных.

Пример:

provider.create_open(...)

Что эквивалентно:

provider.get_destiantion(...).create_open()

См.также

DataProvider.destination().

file_extensions() → List[str]

Список поддерживаемых расширений файлов.

Результат:

Пустой список для не файловых провайдеров.

get_destination() → Destination

Создает назначение объекта данных.

Исключение:

NotImplementedError – Если провайдер не поддерживает создание назначений.

get_source(host: str, db_name: str, user: str, password: str, port: int = DEFAULT_PORT, dataobject: Optional[str] = None, sql: Optional[str] = None, prj: Optional[str] = None, alias: Optional[str] = None, unique: Optional[str] = None) → Source

Создает описательную структуру для источника данных. Она в дальнейшем может быть использована при открытии данных ProviderManager.open().

В качестве таблицы можно указать либо ее наименование dataobject либо текст запроса sql.

Параметры:

  • host – Адрес сервера.

  • db_name – Имя базы данных.

  • user – Имя пользователя.

  • password – Пароль.

  • port – Порт.

  • dataobject – Имя таблицы.

  • sql – SQL-запрос. Если указан, то он имеет более высокий приоритет по отношению к значению dataobject.

  • prj – Строка Системы Координат.

  • alias – Псевдоним для открываемой таблицы.

  • unique – Поле с уникальным значением, которое будет использоваться как идентификатор

property id: str

Идентификатор провайдера.

open(host: str, db_name: str, user: str, password: str, port: int = DEFAULT_PORT, dataobject: Optional[str] = None, sql: Optional[str] = None, prj: Optional[str] = None, alias: Optional[str] = None, unique: Optional[str] = None) → Table

Открывает объект данных.

В качестве таблицы можно указать либо ее наименование dataobject либо текст запроса sql.

Параметры:

  • host – Адрес сервера.

  • db_name – Имя базы данных.

  • user – Имя пользователя.

  • password – Пароль.

  • port – Порт.

  • dataobject – Имя таблицы.

  • sql – SQL-запрос. Если указан, то он имеет более высокий приоритет по отношению к значению dataobject.

  • prj – Строка Системы Координат.

  • alias – Псевдоним для открываемой таблицы.

  • unique – Поле с уникальным значением, которое будет использоваться как идентификатор