destinations.typing
DBApiCursor Objects
class DBApiCursor(Protocol)
Protocol for DBAPI cursor
native_cursor
Cursor implementation native to current destination
df
def df(chunk_size: int = None, **kwargs: None) -> Optional[DataFrame]
Fetches the results as data frame. For large queries the results may be chunked
Fetches the results into a data frame. The default implementation uses helpers in pandas.io.sql
to generate Pandas data frame.
This function will try to use native data frame generation for particular destination. For BigQuery
: QueryJob.to_dataframe
is used.
For duckdb
: `DuckDBPyConnection.df'
Arguments:
chunk_size
int, optional - Will chunk the results into several data frames. Defaults to None**kwargs
Any - Additional parameters which will be passed to native data frame generation function.
Returns:
Optional[DataFrame]
- A data frame with query results. If chunk_size > 0, None will be returned if there is no more data in results