Skip to content

database

AddDatabase dataclass

Source code in zendriver/cdp/database.py 
169
170
171
172
173
174
175
176
@event_class("Database.addDatabase")
@dataclass
class AddDatabase:
    database: Database

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> AddDatabase:
        return cls(database=Database.from_json(json["database"]))

database: Database instance-attribute

__init__(database)

from_json(json) classmethod

Source code in zendriver/cdp/database.py 
174
175
176
@classmethod
def from_json(cls, json: T_JSON_DICT) -> AddDatabase:
    return cls(database=Database.from_json(json["database"]))

Database dataclass

Database object.

Source code in zendriver/cdp/database.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
@dataclass
class Database:
    """
    Database object.
    """

    #: Database ID.
    id_: DatabaseId

    #: Database domain.
    domain: str

    #: Database name.
    name: str

    #: Database version.
    version: str

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["id"] = self.id_.to_json()
        json["domain"] = self.domain
        json["name"] = self.name
        json["version"] = self.version
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> Database:
        return cls(
            id_=DatabaseId.from_json(json["id"]),
            domain=str(json["domain"]),
            name=str(json["name"]),
            version=str(json["version"]),
        )

domain: str instance-attribute

id_: DatabaseId instance-attribute

name: str instance-attribute

version: str instance-attribute

__init__(id_, domain, name, version)

from_json(json) classmethod

Source code in zendriver/cdp/database.py 
57
58
59
60
61
62
63
64
@classmethod
def from_json(cls, json: T_JSON_DICT) -> Database:
    return cls(
        id_=DatabaseId.from_json(json["id"]),
        domain=str(json["domain"]),
        name=str(json["name"]),
        version=str(json["version"]),
    )

to_json()

Source code in zendriver/cdp/database.py 
49
50
51
52
53
54
55
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["id"] = self.id_.to_json()
    json["domain"] = self.domain
    json["name"] = self.name
    json["version"] = self.version
    return json

DatabaseId

Bases: str

Unique identifier of Database object.

Source code in zendriver/cdp/database.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
class DatabaseId(str):
    """
    Unique identifier of Database object.
    """

    def to_json(self) -> str:
        return self

    @classmethod
    def from_json(cls, json: str) -> DatabaseId:
        return cls(json)

    def __repr__(self):
        return "DatabaseId({})".format(super().__repr__())

__repr__()

Source code in zendriver/cdp/database.py 
27
28
def __repr__(self):
    return "DatabaseId({})".format(super().__repr__())

from_json(json) classmethod

Source code in zendriver/cdp/database.py 
23
24
25
@classmethod
def from_json(cls, json: str) -> DatabaseId:
    return cls(json)

to_json()

Source code in zendriver/cdp/database.py 
20
21
def to_json(self) -> str:
    return self

Error dataclass

Database error.

Source code in zendriver/cdp/database.py 
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
@dataclass
class Error:
    """
    Database error.
    """

    #: Error message.
    message: str

    #: Error code.
    code: int

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["message"] = self.message
        json["code"] = self.code
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> Error:
        return cls(
            message=str(json["message"]),
            code=int(json["code"]),
        )

code: int instance-attribute

message: str instance-attribute

__init__(message, code)

from_json(json) classmethod

Source code in zendriver/cdp/database.py 
85
86
87
88
89
90
@classmethod
def from_json(cls, json: T_JSON_DICT) -> Error:
    return cls(
        message=str(json["message"]),
        code=int(json["code"]),
    )

to_json()

Source code in zendriver/cdp/database.py 
79
80
81
82
83
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["message"] = self.message
    json["code"] = self.code
    return json

disable()

Disables database tracking, prevents database events from being sent to the client.

Source code in zendriver/cdp/database.py 
 93
 94
 95
 96
 97
 98
 99
100
def disable() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Disables database tracking, prevents database events from being sent to the client.
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Database.disable",
    }
    json = yield cmd_dict

enable()

Enables database tracking, database events will now be delivered to the client.

Source code in zendriver/cdp/database.py 
103
104
105
106
107
108
109
110
def enable() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Enables database tracking, database events will now be delivered to the client.
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Database.enable",
    }
    json = yield cmd_dict

execute_sql(database_id, query)

Parameters:

Name Type Description Default
database_id DatabaseId
required
query str
required

Returns:

Type Description
Generator[T_JSON_DICT, T_JSON_DICT, Tuple[Optional[List[str]], Optional[List[Any]], Optional[Error]]]

A tuple with the following items: 0. columnNames - 1. values - 2. sqlError -
Source code in zendriver/cdp/database.py 
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
def execute_sql(
    database_id: DatabaseId, query: str
) -> typing.Generator[
    T_JSON_DICT,
    T_JSON_DICT,
    typing.Tuple[
        typing.Optional[typing.List[str]],
        typing.Optional[typing.List[typing.Any]],
        typing.Optional[Error],
    ],
]:
    """
    :param database_id:
    :param query:
    :returns: A tuple with the following items:

        0. **columnNames** -
        1. **values** -
        2. **sqlError** -
    """
    params: T_JSON_DICT = dict()
    params["databaseId"] = database_id.to_json()
    params["query"] = query
    cmd_dict: T_JSON_DICT = {
        "method": "Database.executeSQL",
        "params": params,
    }
    json = yield cmd_dict
    return (
        [str(i) for i in json["columnNames"]]
        if json.get("columnNames", None) is not None
        else None,
        [i for i in json["values"]] if json.get("values", None) is not None else None,
        Error.from_json(json["sqlError"])
        if json.get("sqlError", None) is not None
        else None,
    )

get_database_table_names(database_id)

Parameters:

Name Type Description Default
database_id DatabaseId
required

Returns:

Type Description
Generator[T_JSON_DICT, T_JSON_DICT, List[str]]
Source code in zendriver/cdp/database.py 
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
def get_database_table_names(
    database_id: DatabaseId,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, typing.List[str]]:
    """
    :param database_id:
    :returns:
    """
    params: T_JSON_DICT = dict()
    params["databaseId"] = database_id.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "Database.getDatabaseTableNames",
        "params": params,
    }
    json = yield cmd_dict
    return [str(i) for i in json["tableNames"]]