doquedb package

Subpackages

Module contents

doquedb – DoqueDB接続用パッケージ

doquedb.BINARY: alias of bytes

doquedb.Binary: alias of bytes

class doquedb.Connection(hostname: str, portnum: int, protocol_ver: int, session: Session, user: str | None, password: str | None, master_id: int, charset: str, autocommit: bool = False)

Bases: object

DB-API 2.0 のコネクションクラス. 特定のデータベースとの接続 (セッション) を表現します。

Parameters:

hostname (str) – ホスト名
portnum (int) – ポート番号
protocol_ver (int) – プロトコルバージョン
session (Session) – セッション
user (str) – ユーザー名
password (str) – パスワード
master_id (int) – マスターID
charset (str) – 文字セット
autocommit (bool) – オートコミットのオンオフ. デフォルトはFalse

info

ホスト名、ポート番号、プロトコルバージョンのリスト

Type:: list

_session

セッション

Type:: Session

username

ユーザー名

Type:: str

password

パスワード

Type:: str

master_id

マスターID

Type:: int

charset

文字セット

Type:: str

in_autocommit

オートコミットのオンオフ

Type:: bool

is_closed

クローズしたかどうか

Type:: bool

readonly

読込み専用モードかどうか

Type:: bool

in_transaction

トランザクション中かどうか

Type:: bool

isolation_level

トランザクション遮断レベル

Type:: bool

begin_transaction(transaction_mode: int | None = None) → None

トランザクションを開始する.

Parameters:

transaction_mode –

obj:: `TransactionMode`内のいずれかのトランザクションモード

Notes

このメソッドは自動コミットモードが無効の時にのみ使用する.

property charset: str: 文字コードのゲッター.

close() → None

セッションのクローズ

自動解除を待たずにDoqueDBとのセッションのクローズ処理を直ちに行う。

commit() → None

現在のトランザクションをコミットする.

Raises:

ProgrammingError – プログラミングの誤りによって発生するエラー
InterfaceError – 通信プロトコル周りのエラー時に発生

cursor(prepared: bool | None = False) → Cursor

カーソルの生成

データベース操作のためのカーソルオブジェクトを生成する

Parameters:: prepared (Optional[bool]) – プリペアードステートメント利用フラグ. デフォルトはFalse
Returns:: カーソルオブジェクト
Return type:: Cursor
Raises:: ProgrammingError – 複数のカーソルを作成しようとした場合に発生

Notes

カーソルはコネクションに対して１つしか作成できない。複数のカーソルを同時に作成したい場合はコネクションを新しく生成する必要がある。

property in_transaction: bool: トランザクションのオンオフのゲッター

property info: tuple: 接続情報（ホスト名, ポート番号, プロトコルバージョン）のタプル

property is_autocommit: bool: オートコミットのオンオフのゲッター

property isolation_level: int: “トランザクション遮断レベルのゲッター

isolevel: alias of TransactionIsolationLevel

property master_id: int: マスターIDのゲッター

mode: alias of TransactionMode

property password: str | None: パスワードのゲッター

property readonly: bool: “読込み専用モードかどうか

rollback() → None

現在のトランザクションをロールバックする.

Raises:: exceptions.InterfaceError – 通信プロトコル周りのエラー時に発生

set_readonly(readonly_: bool) → None

読込み専用モードをセットする.

Parameters:

readonly (bool) – 読込み専用モードの設定値

Raises:

ProgrammingError –
UnexpectedError –

set_transaction_isolation(isolation_level: int) → None

トランザクション遮断レベルを指定されたものに変更する.

Parameters:

isolation_level (int) –

obj:: `TransactionIsolationLevel`内のいずれかの定数値

Raises:

ProgrammingError –
UnexpectedError –

property username: str | None: ユーザー名のゲッター

doquedb.DATETIME: alias of datetime

doquedb.DECIMAL: alias of DecimalData

exception doquedb.DataError(error_message)

Bases: DatabaseError

データの処理に関連する例外

Parameters:: error_message (str) – エラーの説明文

error_message

エラーの説明文

Type:: str

exception doquedb.DatabaseError(error_message: str, state_code: str | None = None, error_code: int | None = None)

Bases: Error

データベースから取得した例外のベースとなる例外クラス

Parameters:

error_message (str) – エラーの説明文
state_code (str) – SQLのステート
error_code (int) – エラーコード

error_message

エラーの説明文

Type:: str

state_code

SQLのステート

Type:: Optional[str]

error_code

エラーコード

Type:: Optional[int

doquedb.Date: alias of date

doquedb.DateFromTicks(ticks)

doquedb.Decimal: alias of DecimalData

exception doquedb.Error

Bases: Exception

警告以外の全ての例外クラスのベースとなる例外クラス

exception doquedb.IntegrityError(error_message)

Bases: DatabaseError

データベースのリレーションの整合性に関連する例外

Parameters:: error_message (str) – エラーの説明文

error_message

エラーの説明文

Type:: str

exception doquedb.InterfaceError

Bases: Error

インターフェースに関連する例外クラス

exception doquedb.InternalError(error_message)

Bases: DatabaseError

データベースの内部エラーに関連する例外

Parameters:: error_message (str) – エラーの説明文

error_message

エラーの説明文

Type:: str

doquedb.LANGUAGE: alias of LanguageData

doquedb.Language: alias of LanguageData

doquedb.NUMBER: alias of float

exception doquedb.NotSupportedError(error_message)

Bases: DatabaseError

サポート外の機能に対する例外

Parameters:: error_message (str) – エラーの説明文

error_message

エラーの説明文

Type:: str

exception doquedb.OperationalError(error_message)

Bases: DatabaseError

データベースのオペレーションに関連する例外

Parameters:: error_message (str) – エラーの説明文

error_message

エラーの説明文

Type:: str

exception doquedb.ProgrammingError(error_message)

Bases: DatabaseError

プログラミングエラーに関連する例外

Parameters:: error_message (str) – エラーの説明文

error_message

エラーの説明文

Type:: str

doquedb.ROWID: alias of int

doquedb.STRING: alias of str

doquedb.Time: alias of time

doquedb.TimeFromTicks(ticks)

doquedb.Timestamp: alias of datetime

doquedb.TimestampFromTicks(ticks)

doquedb.WORD: alias of WordData

exception doquedb.Warning

Bases: Exception

警告のための例外クラス

doquedb.connect(host: str = 'localhost', port: int = 54321, user: str = None, password: str = None, dbname: str = 'DefaultDB', charset: str = 'utf8', autocommit: bool = False) → Connection

DoqueDBと接続し, Connectionオブジェクトを返す.

Parameters:

host (str) – ホスト名
port (int) – ポート番号
user (str) – ユーザー名
password (str) – パスワード
dbname (int) – データベース名
charset (str) – 文字セット
autocommit (bool) – オートコミット. デフォルトはFalse

Returns:

Connectionオブジェクト

Return type:

Connection