async def execute_iter(
self,
query,
params=None,
with_column_types=False,
external_tables=None,
query_id=None,
settings=None,
types_check=False,
):
"""
*New in version 0.0.14.*
Executes SELECT query with results streaming. See, :ref:`execute-iter`.
:param query: query that will be send to server.
:param params: substitution parameters for SELECT queries and data for
INSERT queries. Data for INSERT can be `list`, `tuple`
or :data:`~types.GeneratorType`.
Defaults to ``None`` (no parameters or data).
:param with_column_types: if specified column names and types will be
returned alongside with result.
Defaults to ``False``.
:param external_tables: external tables to send.
Defaults to ``None`` (no external tables).
:param query_id: the query identifier. If no query id specified
ClickHouse server will generate it.
:param settings: dictionary of query settings.
Defaults to ``None`` (no additional settings).
:param types_check: enables type checking of data for INSERT queries.
Causes additional overhead. Defaults to ``False``.
:return: :ref:`iter-query-result` proxy.
"""
self.make_query_settings(settings)
await self.force_connect()
self.last_query = QueryInfo(self.reader)
return await self.iter_process_ordinary_query(
query,
params=params,
with_column_types=with_column_types,
external_tables=external_tables,
query_id=query_id,
types_check=types_check,
)
async def __aenter__(self):
await self._connection.force_connect()
self._connection.last_query = QueryInfo(self._connection.reader)
async def execute(
self,
query,
args=None,
with_column_types=False,
external_tables=None,
query_id="",
settings=None,
types_check=False,
columnar=False,
):
"""
Executes query.
Establishes new connection if it wasn't established yet.
After query execution connection remains intact for next queries.
If connection can't be reused it will be closed and new connection will
be created.
:param query: query that will be send to server.
:param args: substitution parameters for SELECT queries and data for
INSERT queries. Data for INSERT can be `list`, `tuple`
or :data:`~types.GeneratorType`.
Defaults to ``None`` (no parameters or data).
:param with_column_types: if specified column names and types will be
returned alongside with result.
Defaults to ``False``.
:param external_tables: external tables to send.
Defaults to ``None`` (no external tables).
:param query_id: the query identifier. If no query id specified
ClickHouse server will generate it.
:param settings: dictionary of query settings.
Defaults to ``None`` (no additional settings).
:param types_check: enables type checking of data for INSERT queries.
Causes additional overhead. Defaults to ``False``.
:param columnar: if specified the result of the SELECT query will be
returned in column-oriented form.
It also allows to INSERT data in columnar form.
Defaults to ``False`` (row-like form).
:return: * number of inserted rows for INSERT queries with data.
Returning rows count from INSERT FROM SELECT is not
supported.
* if `with_column_types=False`: `list` of `tuples` with
rows/columns.
* if `with_column_types=True`: `tuple` of 2 elements:
* The first element is `list` of `tuples` with
rows/columns.
* The second element information is about columns: names
and types.
"""
start_time = time()
self.make_query_settings(settings)
await self.force_connect()
self.last_query = QueryInfo(self.reader)
# INSERT queries can use list/tuple/generator of list/tuples/dicts.
# For SELECT parameters can be passed in only in dict right now.
is_insert = isinstance(args, (list, tuple, GeneratorType))
if is_insert:
rv = await self.process_insert_query(
query,
args,
external_tables=external_tables,
query_id=query_id,
types_check=types_check,
columnar=columnar,
)
else:
rv = await self.process_ordinary_query(
query,
args,
with_column_types=with_column_types,
external_tables=external_tables,
query_id=query_id,
types_check=types_check,
columnar=columnar,
)
self.last_query.store_elapsed(time() - start_time)
return rv