pandas.read_sql_query

pandas.read_sql_query(sql, con, index_col=None, coerce_float=True, params=None, parse_dates=None, chunksize=None, dtype=None, dtype_backend=_NoDefault.no_default)[source]

Чтение SQL запроса в DataFrame.

Возвращает DataFrame, соответствующий набору результатов запроса. Дополнительно можно указать параметр index_col для использования одного из столбцов в качестве индекса; в противном случае используется индекс по умолчанию (целые числа).

Параметры:

sql:строка SQL-запрос или SQLAlchemy Selectable (объект select или text)

SQL-запрос для выполнения.

con:SQLAlchemy connectable, строка или соединение sqlite3

Использование SQLAlchemy позволяет использовать любые базы данных, поддерживаемые этой библиотекой. Если используется объект DBAPI2, поддерживается только sqlite3.

index_col:строка или список строк, необязательно, по умолчанию: None

Столбец(ы) для установки в качестве индекса (MultiIndex).

coerce_float:bool, по умолчанию True

Попытка преобразовать значения нестроковых, нечисловых объектов (например, decimal.Decimal) в числа с плавающей точкой. Полезно для наборов результатов SQL.

params:список, кортеж или отображение, необязательно, по умолчанию: None

Список параметров для передачи методу execute. Синтаксис передачи параметров зависит от драйвера базы данных. Проверьте документацию драйвера базы данных, чтобы узнать, какой из пяти синтаксических стилей, описанных в PEP 249’s paramstyle, поддерживается. Например, для psycopg2 используется %(name)s, поэтому используйте params={‘name’ : ‘value’}.

parse_dates:список или словарь, по умолчанию: None

• Список имён столбцов для парсинга в даты.

• Словарь {column_name: format string}, где строка формата совместима с strftime при парсинге строковых дат, или является одним из (D, s, ns, ms, us) в случае парсинга целочисленных временных меток.

• Словарь {column_name: arg dict}, где словарь аргументов соответствует ключевым аргументам pandas.to_datetime() Особенно полезно для баз данных без встроенной поддержки дат, таких как SQLite.

chunksize:целое число, по умолчанию None

Если указано, возвращается итератор, где chunksize — количество строк в каждом фрагменте.

dtype:Имя типа или словарь столбцов

Тип данных для данных или столбцов. Например, np.float64 или {‘a’: np.float64, ‘b’: np.int32, ‘c’: ‘Int64’}.

Добавлен в версии 1.3.0.

dtype_backend:{‘numpy_nullable’, ‘pyarrow’}, по умолчанию ‘numpy_nullable’

Обработка типа данных, применяемая к результирующему DataFrame (пока экспериментальная функция). Поведение следующее:

• "numpy_nullable": возвращает DataFrame с поддержкой nullable-dtype (по умолчанию).

• "pyarrow": возвращает DataFrame с поддержкой pyarrow и nullable ArrowDtype.

Добавлен в версии 2.0.

Возвращает:

DataFrame или Iterator[DataFrame]

См. также

read_sql_table

Чтение таблицы SQL базы данных в DataFrame.

read_sql

Чтение SQL-запроса или таблицы базы данных в DataFrame.

Примечания

Любые даты со временной зоной, пропарсенные с помощью параметра parse_dates, будут преобразованы в UTC.

Примеры

>>> from sqlalchemy import create_engine  
>>> engine = create_engine("sqlite:///database.db")  
>>> with engine.connect() as conn, conn.begin():  
...     data = pd.read_sql_table("data", conn)