asyncmy
Native execution adapter for asyncmy (mysql+asyncmy:// URLs).
AsyncmyAdapter
Bases: DriverAdapter
Runs bound statements on asyncmy cursors, which take %s-style SQL and
a tuple of arguments::
| Text Only | |
|---|---|
1 | |
Arguments are always passed as a tuple, even when empty. asyncmy only
applies % formatting when arguments are given, and SQLAlchemy compiles
a literal % as %%, so LIKE 'a%%' would otherwise reach MySQL
with the %% intact.
Source code in ormar/databases/native/adapters/asyncmy.py
| Python | |
|---|---|
22 23 24 25 26 27 28 29 30 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 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 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 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 | |
__init__(dialect)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dialect
|
Dialect
|
dialect of the connected database |
required |
Source code in ormar/databases/native/adapters/asyncmy.py
| Python | |
|---|---|
35 36 37 38 39 40 41 42 43 44 45 | |
execute(raw, bound)
async
Run a write statement. MySQL has no RETURNING, so a generated primary
key comes from cursor.lastrowid and the row count from
cursor.rowcount.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
raw
|
Any
|
pooled raw connection |
required |
bound
|
BoundStatement
|
statement to execute |
required |
Returns:
| Type | Description |
|---|---|
Any
|
inserted primary key for INSERT, row count otherwise |
Source code in ormar/databases/native/adapters/asyncmy.py
| Python | |
|---|---|
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 | |
execute_many(raw, batch)
async
Run a statement once per row with the cursor's executemany.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
raw
|
Any
|
pooled raw connection |
required |
batch
|
BoundBatch
|
statement and arguments per row |
required |
Source code in ormar/databases/native/adapters/asyncmy.py
| Python | |
|---|---|
93 94 95 96 97 98 99 100 101 102 103 104 105 | |
fetch_all(raw, bound, as_tuples=False)
async
Run a statement on a cursor and return all rows keyed by result label;
the result column types come from cursor.description.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
raw
|
Any
|
pooled raw connection |
required |
bound
|
BoundStatement
|
statement to execute |
required |
as_tuples
|
bool
|
return tuples of values in select order instead |
False
|
Returns:
| Type | Description |
|---|---|
List[Any]
|
rows |
Source code in ormar/databases/native/adapters/asyncmy.py
| Python | |
|---|---|
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 | |
stream(raw, bound, batch_size)
async
Stream rows through an unbuffered cursor (SSCursor), which reads
rows from the network as they are fetched instead of loading the whole
result first. The cursor is always closed at the end, because MySQL
cannot run another statement on the connection while it is open.
The execution lock is held per fetch only (see the asyncpg adapter).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
raw
|
Any
|
pooled raw connection |
required |
bound
|
BoundStatement
|
statement to execute |
required |
batch_size
|
int
|
rows fetched per round trip |
required |
Returns:
| Type | Description |
|---|---|
AsyncGenerator[Dict[str, Any], None]
|
rows keyed by result label |
Source code in ormar/databases/native/adapters/asyncmy.py
| Python | |
|---|---|
107 108 109 110 111 112 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 | |
translate_error(error, dbapi_connection)
Map an asyncmy exception the way SQLAlchemy's asyncmy wrapper does.
asyncmy raises AttributeError when its connection is gone in the
middle of a call; the wrapper turns it into InternalError so the
dialect recognises a disconnect and drops the connection.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
error
|
BaseException
|
exception raised by asyncmy |
required |
dbapi_connection
|
Any
|
SQLAlchemy's adapted asyncmy connection |
required |
Returns:
| Type | Description |
|---|---|
BaseException
|
DBAPI-level exception |
Source code in ormar/databases/native/adapters/asyncmy.py
| Python | |
|---|---|
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 | |