duckdb API Reference
Full documentation for duckdb (1.5.5)
duckdb.BINARY
Python Library Documentation: DBAPITypeObject in module duckdb._dbapi_type_object object class DBAPITypeObject(builtins.object) | DBAPITypeObject(types: list[_duckdb._sqltypes.DuckDBPyType]) -> None | | DB API 2.0 type object for categorizing database column types. | | This class implements the type objects defined in PEP 249 (DB API 2.0). | It allows checking whether a specific DuckDB type belongs to a broader | category like STRING, NUMBER, DATETIME, etc. | | The type object supports equality comparison with DuckDBPyType instances, | returning True if the type belongs to this category. | | Args: | types: A list of DuckDBPyType instances that belong to this type category. | | Example: | >>> string_types = DBAPITypeObject([sqltypes.VARCHAR, sqltypes.CHAR]) | >>> result = sqltypes.VARCHAR == string_types # True | >>> result = sqltypes.INTEGER == string_types # False | | Note: | This follows the DB API 2.0 specification where type objects are compared | using equality operators rather than isinstance() checks. | | Methods defined here: | | __eq__(self, other: object) -> bool | Check if a DuckDB type belongs to this type category. | | This method implements the DB API 2.0 type checking mechanism. | It returns True if the other object is a DuckDBPyType that | is contained in this type category. | | Args: | other: The object to compare, typically a DuckDBPyType instance. | | Returns: | True if other is a DuckDBPyType in this category, False otherwise. | | Example: | >>> NUMBER == sqltypes.INTEGER # True | >>> NUMBER == sqltypes.VARCHAR # False | | __init__(self, types: list[_duckdb._sqltypes.DuckDBPyType]) -> None | Initialize a DB API type object. | | Args: | types: List of DuckDB types that belong to this category. | | __repr__(self) -> str | Return a string representation of this type object. | | Returns: | A string showing the type object and its contained DuckDB types. | | Example: | >>> repr(STRING) | '<DBAPITypeObject [VARCHAR]>' | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __hash__ = None
duckdb.BinaryValue
Python Library Documentation: class BinaryValue in module duckdb.value.constant class BinaryValue(Value) | BinaryValue(object: Any) -> None | | Method resolution order: | BinaryValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.BinderException
Python Library Documentation: class BinderException in module _duckdb class BinderException(ProgrammingError) | Method resolution order: | BinderException | ProgrammingError | DatabaseError | Error | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors inherited from Error: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) class method of builtins.Exception | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args
duckdb.BitValue
Python Library Documentation: class BitValue in module duckdb.value.constant class BitValue(Value) | BitValue(object: Any) -> None | | Method resolution order: | BitValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.BlobValue
Python Library Documentation: class BlobValue in module duckdb.value.constant class BlobValue(Value) | BlobValue(object: Any) -> None | | Method resolution order: | BlobValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.BooleanValue
Python Library Documentation: class BooleanValue in module duckdb.value.constant class BooleanValue(Value) | BooleanValue(object: Any) -> None | | Method resolution order: | BooleanValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.CSVLineTerminator
Python Library Documentation: class CSVLineTerminator in module _duckdb class CSVLineTerminator(pybind11_builtins.pybind11_object) | Method resolution order: | CSVLineTerminator | pybind11_builtins.pybind11_object | builtins.object | | Methods defined here: | | __eq__(...) | __eq__(self: object, other: object, /) -> bool | | __getstate__(...) | __getstate__(self: object, /) -> int | | __hash__(...) | __hash__(self: object, /) -> int | | __index__(...) | __index__(self: _duckdb.CSVLineTerminator, /) -> int | | __init__(...) | __init__(self: _duckdb.CSVLineTerminator, value: typing.SupportsInt | typing.SupportsIndex) -> None | | __int__(...) | __int__(self: _duckdb.CSVLineTerminator, /) -> int | | __ne__(...) | __ne__(self: object, other: object, /) -> bool | | __repr__(...) | __repr__(self: object, /) -> str | | __setstate__(...) | __setstate__(self: _duckdb.CSVLineTerminator, state: typing.SupportsInt | typing.SupportsIndex, /) -> None | | __str__(...) | __str__(self: object, /) -> str | | ---------------------------------------------------------------------- | Readonly properties defined here: | | __members__ | | name | name(self: object, /) -> str | | value | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | CARRIAGE_RETURN_LINE_FEED = <CSVLineTerminator.CARRIAGE_RETURN_LINE_FE... | | LINE_FEED = <CSVLineTerminator.LINE_FEED: 0> | | ---------------------------------------------------------------------- | Static methods inherited from pybind11_builtins.pybind11_object: | | __new__(*args, **kwargs) class method of pybind11_builtins.pybind11_object | Create and return a new object. See help(type) for accurate signature.
duckdb.CaseExpression
Python Library Documentation: built-in function CaseExpression in module _duckdb
CaseExpression(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
CaseExpression(condition: _duckdb.Expression, value: _duckdb.Expression) -> _duckdb.Expression
duckdb.CatalogException
Python Library Documentation: class CatalogException in module _duckdb class CatalogException(ProgrammingError) | Method resolution order: | CatalogException | ProgrammingError | DatabaseError | Error | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors inherited from Error: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) class method of builtins.Exception | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args
duckdb.CoalesceOperator
Python Library Documentation: built-in function CoalesceOperator in module _duckdb
CoalesceOperator(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
CoalesceOperator(*args) -> _duckdb.Expression
duckdb.ColumnExpression
Python Library Documentation: built-in function ColumnExpression in module _duckdb
ColumnExpression(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
ColumnExpression(*args) -> _duckdb.Expression
Create a column reference from the provided column name
duckdb.ConnectionException
Python Library Documentation: class ConnectionException in module _duckdb class ConnectionException(OperationalError) | Method resolution order: | ConnectionException | OperationalError | DatabaseError | Error | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors inherited from Error: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) class method of builtins.Exception | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args
duckdb.ConstantExpression
Python Library Documentation: built-in function ConstantExpression in module _duckdb
ConstantExpression(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
ConstantExpression(value: object) -> _duckdb.Expression
Create a constant expression from the provided value
duckdb.ConstraintException
Python Library Documentation: class ConstraintException in module _duckdb class ConstraintException(IntegrityError) | Method resolution order: | ConstraintException | IntegrityError | DatabaseError | Error | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors inherited from Error: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) class method of builtins.Exception | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args
duckdb.ConversionException
Python Library Documentation: class ConversionException in module _duckdb class ConversionException(DataError) | Method resolution order: | ConversionException | DataError | DatabaseError | Error | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors inherited from Error: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) class method of builtins.Exception | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args
duckdb.DATETIME
Python Library Documentation: DBAPITypeObject in module duckdb._dbapi_type_object object class DBAPITypeObject(builtins.object) | DBAPITypeObject(types: list[_duckdb._sqltypes.DuckDBPyType]) -> None | | DB API 2.0 type object for categorizing database column types. | | This class implements the type objects defined in PEP 249 (DB API 2.0). | It allows checking whether a specific DuckDB type belongs to a broader | category like STRING, NUMBER, DATETIME, etc. | | The type object supports equality comparison with DuckDBPyType instances, | returning True if the type belongs to this category. | | Args: | types: A list of DuckDBPyType instances that belong to this type category. | | Example: | >>> string_types = DBAPITypeObject([sqltypes.VARCHAR, sqltypes.CHAR]) | >>> result = sqltypes.VARCHAR == string_types # True | >>> result = sqltypes.INTEGER == string_types # False | | Note: | This follows the DB API 2.0 specification where type objects are compared | using equality operators rather than isinstance() checks. | | Methods defined here: | | __eq__(self, other: object) -> bool | Check if a DuckDB type belongs to this type category. | | This method implements the DB API 2.0 type checking mechanism. | It returns True if the other object is a DuckDBPyType that | is contained in this type category. | | Args: | other: The object to compare, typically a DuckDBPyType instance. | | Returns: | True if other is a DuckDBPyType in this category, False otherwise. | | Example: | >>> NUMBER == sqltypes.INTEGER # True | >>> NUMBER == sqltypes.VARCHAR # False | | __init__(self, types: list[_duckdb._sqltypes.DuckDBPyType]) -> None | Initialize a DB API type object. | | Args: | types: List of DuckDB types that belong to this category. | | __repr__(self) -> str | Return a string representation of this type object. | | Returns: | A string showing the type object and its contained DuckDB types. | | Example: | >>> repr(STRING) | '<DBAPITypeObject [VARCHAR]>' | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __hash__ = None
duckdb.DBAPITypeObject
Python Library Documentation: class DBAPITypeObject in module duckdb._dbapi_type_object class DBAPITypeObject(builtins.object) | DBAPITypeObject(types: list[_duckdb._sqltypes.DuckDBPyType]) -> None | | DB API 2.0 type object for categorizing database column types. | | This class implements the type objects defined in PEP 249 (DB API 2.0). | It allows checking whether a specific DuckDB type belongs to a broader | category like STRING, NUMBER, DATETIME, etc. | | The type object supports equality comparison with DuckDBPyType instances, | returning True if the type belongs to this category. | | Args: | types: A list of DuckDBPyType instances that belong to this type category. | | Example: | >>> string_types = DBAPITypeObject([sqltypes.VARCHAR, sqltypes.CHAR]) | >>> result = sqltypes.VARCHAR == string_types # True | >>> result = sqltypes.INTEGER == string_types # False | | Note: | This follows the DB API 2.0 specification where type objects are compared | using equality operators rather than isinstance() checks. | | Methods defined here: | | __eq__(self, other: object) -> bool | Check if a DuckDB type belongs to this type category. | | This method implements the DB API 2.0 type checking mechanism. | It returns True if the other object is a DuckDBPyType that | is contained in this type category. | | Args: | other: The object to compare, typically a DuckDBPyType instance. | | Returns: | True if other is a DuckDBPyType in this category, False otherwise. | | Example: | >>> NUMBER == sqltypes.INTEGER # True | >>> NUMBER == sqltypes.VARCHAR # False | | __init__(self, types: list[_duckdb._sqltypes.DuckDBPyType]) -> None | Initialize a DB API type object. | | Args: | types: List of DuckDB types that belong to this category. | | __repr__(self) -> str | Return a string representation of this type object. | | Returns: | A string showing the type object and its contained DuckDB types. | | Example: | >>> repr(STRING) | '<DBAPITypeObject [VARCHAR]>' | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __hash__ = None
duckdb.DataError
Python Library Documentation: class DataError in module _duckdb class DataError(DatabaseError) | Method resolution order: | DataError | DatabaseError | Error | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors inherited from Error: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) class method of builtins.Exception | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args
duckdb.DatabaseError
Python Library Documentation: class DatabaseError in module _duckdb class DatabaseError(Error) | Method resolution order: | DatabaseError | Error | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors inherited from Error: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) class method of builtins.Exception | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args
duckdb.DateValue
Python Library Documentation: class DateValue in module duckdb.value.constant class DateValue(Value) | DateValue(object: Any) -> None | | Method resolution order: | DateValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.DecimalValue
Python Library Documentation: class DecimalValue in module duckdb.value.constant class DecimalValue(Value) | DecimalValue(object: Any, width: int, scale: int) -> None | | Method resolution order: | DecimalValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any, width: int, scale: int) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.DefaultExpression
Python Library Documentation: built-in function DefaultExpression in module _duckdb
DefaultExpression(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
DefaultExpression() -> _duckdb.Expression
duckdb.DependencyException
Python Library Documentation: class DependencyException in module _duckdb class DependencyException(DatabaseError) | Method resolution order: | DependencyException | DatabaseError | Error | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors inherited from Error: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) class method of builtins.Exception | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args
duckdb.DoubleValue
Python Library Documentation: class DoubleValue in module duckdb.value.constant class DoubleValue(Value) | DoubleValue(object: Any) -> None | | Method resolution order: | DoubleValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.DuckDBPyConnection
Python Library Documentation: class DuckDBPyConnection in module _duckdb class DuckDBPyConnection(pybind11_builtins.pybind11_object) | Method resolution order: | DuckDBPyConnection | pybind11_builtins.pybind11_object | builtins.object | | Methods defined here: | | __del__(...) | __del__(self: _duckdb.DuckDBPyConnection) -> None | | __enter__(...) | __enter__(self: _duckdb.DuckDBPyConnection) -> _duckdb.DuckDBPyConnection | | __exit__(...) | __exit__(self: _duckdb.DuckDBPyConnection, exc_type: object, exc: object, traceback: object) -> None | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | append(...) | append(self: _duckdb.DuckDBPyConnection, table_name: str, df: pandas.DataFrame, *, by_name: bool = False) -> _duckdb.DuckDBPyConnection | | Append the passed DataFrame to the named table | | array_type(...) | array_type(self: _duckdb.DuckDBPyConnection, type: _duckdb._sqltypes.DuckDBPyType, size: typing.SupportsInt | typing.SupportsIndex) -> _duckdb._sqltypes.DuckDBPyType | | Create an array type object of 'type' | | arrow(...) | arrow(self: _duckdb.DuckDBPyConnection, rows_per_batch: typing.SupportsInt | typing.SupportsIndex = 1000000) -> pyarrow.lib.RecordBatchReader | | Alias of to_arrow_reader(). We recommend using to_arrow_reader() instead. | | begin(...) | begin(self: _duckdb.DuckDBPyConnection) -> _duckdb.DuckDBPyConnection | | Start a new transaction | | checkpoint(...) | checkpoint(self: _duckdb.DuckDBPyConnection) -> _duckdb.DuckDBPyConnection | | Synchronizes data in the write-ahead log (WAL) to the database data file (no-op for in-memory connections) | | close(...) | close(self: _duckdb.DuckDBPyConnection) -> None | | Close the connection | | commit(...) | commit(self: _duckdb.DuckDBPyConnection) -> _duckdb.DuckDBPyConnection | | Commit changes performed within a transaction | | create_function(...) | create_function(self: _duckdb.DuckDBPyConnection, name: str, function: collections.abc.Callable, parameters: object = None, return_type: _duckdb._sqltypes.DuckDBPyType = None, *, type: _duckdb._func.PythonUDFType = <PythonUDFType.NATIVE: 0>, null_handling: _duckdb._func.FunctionNullHandling = <FunctionNullHandling.DEFAULT: 0>, exception_handling: _duckdb.PythonExceptionHandling = <PythonExceptionHandling.DEFAULT: 0>, side_effects: bool = False) -> _duckdb.DuckDBPyConnection | | Create a DuckDB function out of the passing in Python function so it can be used in queries | | cursor(...) | cursor(self: _duckdb.DuckDBPyConnection) -> _duckdb.DuckDBPyConnection | | Create a duplicate of the current connection | | decimal_type(...) | decimal_type(self: _duckdb.DuckDBPyConnection, width: typing.SupportsInt | typing.SupportsIndex, scale: typing.SupportsInt | typing.SupportsIndex) -> _duckdb._sqltypes.DuckDBPyType | | Create a decimal type with 'width' and 'scale' | | df(...) | df(self: _duckdb.DuckDBPyConnection, *, date_as_object: bool = False) -> pandas.DataFrame | | Fetch a result as DataFrame following execute() | | disable_profiling(...) | disable_profiling(self: _duckdb.DuckDBPyConnection) -> None | | Disable profiling for subsequent queries | | dtype(...) | dtype(self: _duckdb.DuckDBPyConnection, type_str: str) -> _duckdb._sqltypes.DuckDBPyType | | Create a type object by parsing the 'type_str' string | | duplicate(...) | duplicate(self: _duckdb.DuckDBPyConnection) -> _duckdb.DuckDBPyConnection | | Create a duplicate of the current connection | | enable_profiling(...) | enable_profiling(self: _duckdb.DuckDBPyConnection) -> None | | Enable profiling for subsequent queries | | enum_type(...) | enum_type(self: _duckdb.DuckDBPyConnection, name: str, type: _duckdb._sqltypes.DuckDBPyType, values: list) -> _duckdb._sqltypes.DuckDBPyType | | Create an enum type of underlying 'type', consisting of the list of 'values' | | execute(...) | execute(self: _duckdb.DuckDBPyConnection, query: object, parameters: object = None) -> _duckdb.DuckDBPyConnection | | Execute the given SQL query, optionally using prepared statements with parameters set | | executemany(...) | executemany(self: _duckdb.DuckDBPyConnection, query: object, parameters: object = None) -> _duckdb.DuckDBPyConnection | | Execute the given prepared statement multiple times using the list of parameter sets in parameters | | extract_statements(...) | extract_statements(self: _duckdb.DuckDBPyConnection, query: str) -> list | | Parse the query string and extract the Statement object(s) produced | | fetch_arrow_table(...) | fetch_arrow_table(self: _duckdb.DuckDBPyConnection, rows_per_batch: typing.SupportsInt | typing.SupportsIndex = 1000000) -> pyarrow.lib.Table | | Fetch a result as Arrow table following execute() | | fetch_df(...) | fetch_df(self: _duckdb.DuckDBPyConnection, *, date_as_object: bool = False) -> pandas.DataFrame | | Fetch a result as DataFrame following execute() | | fetch_df_chunk(...) | fetch_df_chunk(self: _duckdb.DuckDBPyConnection, vectors_per_chunk: typing.SupportsInt | typing.SupportsIndex = 1, *, date_as_object: bool = False) -> pandas.DataFrame | | Fetch a chunk of the result as DataFrame following execute() | | fetch_record_batch(...) | fetch_record_batch(self: _duckdb.DuckDBPyConnection, rows_per_batch: typing.SupportsInt | typing.SupportsIndex = 1000000) -> pyarrow.lib.RecordBatchReader | | Fetch an Arrow RecordBatchReader following execute() | | fetchall(...) | fetchall(self: _duckdb.DuckDBPyConnection) -> list | | Fetch all rows from a result following execute | | fetchdf(...) | fetchdf(self: _duckdb.DuckDBPyConnection, *, date_as_object: bool = False) -> pandas.DataFrame | | Fetch a result as DataFrame following execute() | | fetchmany(...) | fetchmany(self: _duckdb.DuckDBPyConnection, size: typing.SupportsInt | typing.SupportsIndex = 1) -> list | | Fetch the next set of rows from a result following execute | | fetchnumpy(...) | fetchnumpy(self: _duckdb.DuckDBPyConnection) -> dict | | Fetch a result as list of NumPy arrays following execute | | fetchone(...) | fetchone(self: _duckdb.DuckDBPyConnection) -> typing.Optional[tuple] | | Fetch a single row from a result following execute | | filesystem_is_registered(...) | filesystem_is_registered(self: _duckdb.DuckDBPyConnection, name: str) -> bool | | Check if a filesystem with the provided name is currently registered | | from_arrow(...) | from_arrow(self: _duckdb.DuckDBPyConnection, arrow_object: object) -> _duckdb.DuckDBPyRelation | | Create a relation object from an Arrow object | | from_csv_auto(...) | from_csv_auto(self: _duckdb.DuckDBPyConnection, path_or_buffer: object, **kwargs) -> _duckdb.DuckDBPyRelation | | Create a relation object from the CSV file in 'name' | | from_df(...) | from_df(self: _duckdb.DuckDBPyConnection, df: pandas.DataFrame) -> _duckdb.DuckDBPyRelation | | Create a relation object from the DataFrame in df | | from_parquet(...) | from_parquet(self: _duckdb.DuckDBPyConnection, path_or_buffer: object, binary_as_string: bool = False, *, file_row_number: bool = False, filename: bool = False, hive_partitioning: bool = False, union_by_name: bool = False, compression: object = None) -> _duckdb.DuckDBPyRelation | | Create a relation object from the Parquet path(s) or file-like object(s) in 'path_or_buffer' | | from_query(...) | from_query(self: _duckdb.DuckDBPyConnection, query: object, *, alias: str = '', params: object = None) -> _duckdb.DuckDBPyRelation | | Run a SQL query. If it is a SELECT statement, create a relation object from the given SQL query, otherwise run the query as-is. | | get_profiling_information(...) | get_profiling_information(self: _duckdb.DuckDBPyConnection, format: str = 'json') -> str | | Get profiling information for a query | | get_table_names(...) | get_table_names(self: _duckdb.DuckDBPyConnection, query: str, *, qualified: bool = False) -> set[str] | | Extract the required table names from a query | | install_extension(...) | install_extension(self: _duckdb.DuckDBPyConnection, extension: str, *, force_install: bool = False, repository: object = None, repository_url: object = None, version: object = None) -> None | | Install an extension by name, with an optional version and/or repository to get the extension from | | interrupt(...) | interrupt(self: _duckdb.DuckDBPyConnection) -> None | | Interrupt pending operations | | list_filesystems(...) | list_filesystems(self: _duckdb.DuckDBPyConnection) -> list | | List registered filesystems, including builtin ones | | list_type(...) | list_type(self: _duckdb.DuckDBPyConnection, type: _duckdb._sqltypes.DuckDBPyType) -> _duckdb._sqltypes.DuckDBPyType | | Create a list type object of 'type' | | load_extension(...) | load_extension(self: _duckdb.DuckDBPyConnection, extension: str) -> None | | Load an installed extension | | map_type(...) | map_type(self: _duckdb.DuckDBPyConnection, key: _duckdb._sqltypes.DuckDBPyType, value: _duckdb._sqltypes.DuckDBPyType) -> _duckdb._sqltypes.DuckDBPyType | | Create a map type object from 'key_type' and 'value_type' | | pl(...) | pl(self: _duckdb.DuckDBPyConnection, rows_per_batch: typing.SupportsInt | typing.SupportsIndex = 1000000, *, lazy: bool = False) -> duckdb::PolarsDataFrame | | Fetch a result as Polars DataFrame following execute() | | query(...) | query(self: _duckdb.DuckDBPyConnection, query: object, *, alias: str = '', params: object = None) -> _duckdb.DuckDBPyRelation | | Run a SQL query. If it is a SELECT statement, create a relation object from the given SQL query, otherwise run the query as-is. | | query_progress(...) | query_progress(self: _duckdb.DuckDBPyConnection) -> float | | Query progress of pending operation | | read_csv(...) | read_csv(self: _duckdb.DuckDBPyConnection, path_or_buffer: object, **kwargs) -> _duckdb.DuckDBPyRelation | | Create a relation object from the CSV file in 'name' | | read_json(...) | read_json(self: _duckdb.DuckDBPyConnection, path_or_buffer: object, *, columns: typing.Optional[object] = None, sample_size: typing.Optional[object] = None, maximum_depth: typing.Optional[object] = None, records: typing.Optional[str] = None, format: typing.Optional[str] = None, date_format: typing.Optional[object] = None, timestamp_format: typing.Optional[object] = None, compression: typing.Optional[object] = None, maximum_object_size: typing.Optional[object] = None, ignore_errors: typing.Optional[object] = None, convert_strings_to_integers: typing.Optional[object] = None, field_appearance_threshold: typing.Optional[object] = None, map_inference_threshold: typing.Optional[object] = None, maximum_sample_files: typing.Optional[object] = None, filename: typing.Optional[object] = None, hive_partitioning: typing.Optional[object] = None, union_by_name: typing.Optional[object] = None, hive_types: typing.Optional[object] = None, hive_types_autocast: typing.Optional[object] = None) -> _duckdb.DuckDBPyRelation | | Create a relation object from the JSON file in 'name' | | read_parquet(...) | read_parquet(self: _duckdb.DuckDBPyConnection, path_or_buffer: object, binary_as_string: bool = False, *, file_row_number: bool = False, filename: bool = False, hive_partitioning: bool = False, union_by_name: bool = False, compression: object = None) -> _duckdb.DuckDBPyRelation | | Create a relation object from the Parquet path(s) or file-like object(s) in 'path_or_buffer' | | register(...) | register(self: _duckdb.DuckDBPyConnection, view_name: str, python_object: object) -> _duckdb.DuckDBPyConnection | | Register the passed Python Object value for querying with a view | | register_filesystem(...) | register_filesystem(self: _duckdb.DuckDBPyConnection, filesystem: fsspec.AbstractFileSystem) -> None | | Register a fsspec compliant filesystem | | remove_function(...) | remove_function(self: _duckdb.DuckDBPyConnection, name: str) -> _duckdb.DuckDBPyConnection | | Remove a previously created function | | rollback(...) | rollback(self: _duckdb.DuckDBPyConnection) -> _duckdb.DuckDBPyConnection | | Roll back changes performed within a transaction | | row_type(...) | row_type(self: _duckdb.DuckDBPyConnection, fields: object) -> _duckdb._sqltypes.DuckDBPyType | | Create a struct type object from 'fields' | | sql(...) | sql(self: _duckdb.DuckDBPyConnection, query: object, *, alias: str = '', params: object = None) -> _duckdb.DuckDBPyRelation | | Run a SQL query. If it is a SELECT statement, create a relation object from the given SQL query, otherwise run the query as-is. | | sqltype(...) | sqltype(self: _duckdb.DuckDBPyConnection, type_str: str) -> _duckdb._sqltypes.DuckDBPyType | | Create a type object by parsing the 'type_str' string | | string_type(...) | string_type(self: _duckdb.DuckDBPyConnection, collation: str = '') -> _duckdb._sqltypes.DuckDBPyType | | Create a string type with an optional collation | | struct_type(...) | struct_type(self: _duckdb.DuckDBPyConnection, fields: object) -> _duckdb._sqltypes.DuckDBPyType | | Create a struct type object from 'fields' | | table(...) | table(self: _duckdb.DuckDBPyConnection, table_name: str) -> _duckdb.DuckDBPyRelation | | Create a relation object for the named table | | table_function(...) | table_function(self: _duckdb.DuckDBPyConnection, name: str, parameters: object = None) -> _duckdb.DuckDBPyRelation | | Create a relation object from the named table function with given parameters | | tf(...) | tf(self: _duckdb.DuckDBPyConnection) -> dict | | Fetch a result as dict of TensorFlow Tensors following execute() | | to_arrow_reader(...) | to_arrow_reader(self: _duckdb.DuckDBPyConnection, batch_size: typing.SupportsInt | typing.SupportsIndex = 1000000) -> pyarrow.lib.RecordBatchReader | | Fetch an Arrow RecordBatchReader following execute() | | to_arrow_table(...) | to_arrow_table(self: _duckdb.DuckDBPyConnection, batch_size: typing.SupportsInt | typing.SupportsIndex = 1000000) -> pyarrow.lib.Table | | Fetch a result as Arrow table following execute() | | torch(...) | torch(self: _duckdb.DuckDBPyConnection) -> dict | | Fetch a result as dict of PyTorch Tensors following execute() | | type(...) | type(self: _duckdb.DuckDBPyConnection, type_str: str) -> _duckdb._sqltypes.DuckDBPyType | | Create a type object by parsing the 'type_str' string | | union_type(...) | union_type(self: _duckdb.DuckDBPyConnection, members: object) -> _duckdb._sqltypes.DuckDBPyType | | Create a union type object from 'members' | | unregister(...) | unregister(self: _duckdb.DuckDBPyConnection, view_name: str) -> _duckdb.DuckDBPyConnection | | Unregister the view name | | unregister_filesystem(...) | unregister_filesystem(self: _duckdb.DuckDBPyConnection, name: str) -> None | | Unregister a filesystem | | values(...) | values(self: _duckdb.DuckDBPyConnection, *args) -> _duckdb.DuckDBPyRelation | | Create a relation object from the passed values | | view(...) | view(self: _duckdb.DuckDBPyConnection, view_name: str) -> _duckdb.DuckDBPyRelation | | Create a relation object for the named view | | ---------------------------------------------------------------------- | Readonly properties defined here: | | description | Get result set attributes, mainly column names | | rowcount | Get result set row count | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __pybind11_module_local_v11_msvc_mt_mscver1944__ = <capsule object NUL... | | ---------------------------------------------------------------------- | Static methods inherited from pybind11_builtins.pybind11_object: | | __new__(*args, **kwargs) class method of pybind11_builtins.pybind11_object | Create and return a new object. See help(type) for accurate signature.
duckdb.DuckDBPyRelation
Python Library Documentation: class DuckDBPyRelation in module _duckdb class DuckDBPyRelation(pybind11_builtins.pybind11_object) | Method resolution order: | DuckDBPyRelation | pybind11_builtins.pybind11_object | builtins.object | | Methods defined here: | | __arrow_c_stream__(...) | __arrow_c_stream__(self: _duckdb.DuckDBPyRelation, requested_schema: object = None) -> object | | | Execute and return an ArrowArrayStream through the Arrow PyCapsule Interface. | | https://arrow.apache.org/docs/dev/format/CDataInterface/PyCapsuleInterface.html | | __contains__(...) | __contains__(self: _duckdb.DuckDBPyRelation, name: str) -> bool | | __getattr__(...) | __getattr__(self: _duckdb.DuckDBPyRelation, name: str) -> _duckdb.DuckDBPyRelation | | Get a projection relation created from this relation, on the provided column name | | __getitem__(...) | __getitem__(self: _duckdb.DuckDBPyRelation, name: str) -> _duckdb.DuckDBPyRelation | | Get a projection relation created from this relation, on the provided column name | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | __len__(...) | __len__(self: _duckdb.DuckDBPyRelation) -> int | | Number of rows in relation. | | __repr__(...) | __repr__(self: _duckdb.DuckDBPyRelation) -> str | | __str__(...) | __str__(self: _duckdb.DuckDBPyRelation) -> str | | aggregate(...) | aggregate(self: _duckdb.DuckDBPyRelation, aggr_expr: object, group_expr: str = '') -> _duckdb.DuckDBPyRelation | | Compute the aggregate aggr_expr by the optional groups group_expr on the relation | | any_value(...) | any_value(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Returns the first non-null value from a given expression | | apply(...) | apply(self: _duckdb.DuckDBPyRelation, function_name: str, function_aggr: str, group_expr: str = '', function_parameter: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Compute the function of a single column or a list of columns by the optional groups on the relation | | arg_max(...) | arg_max(self: _duckdb.DuckDBPyRelation, arg_column: str, value_column: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Finds the row with the maximum value for a value column and returns the value of that row for an argument column | | arg_min(...) | arg_min(self: _duckdb.DuckDBPyRelation, arg_column: str, value_column: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Finds the row with the minimum value for a value column and returns the value of that row for an argument column | | arrow(...) | arrow(self: _duckdb.DuckDBPyRelation, batch_size: typing.SupportsInt | typing.SupportsIndex = 1000000) -> pyarrow.lib.RecordBatchReader | | Alias of to_arrow_reader(). We recommend using to_arrow_reader() instead. | | avg(...) | avg(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the average of a given expression | | bit_and(...) | bit_and(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the bitwise AND of all bits present in a given expression | | bit_or(...) | bit_or(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the bitwise OR of all bits present in a given expression | | bit_xor(...) | bit_xor(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the bitwise XOR of all bits present in a given expression | | bitstring_agg(...) | bitstring_agg(self: _duckdb.DuckDBPyRelation, expression: str, min: typing.Optional[object] = None, max: typing.Optional[object] = None, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes a bitstring with bits set for each distinct value in a given expression | | bool_and(...) | bool_and(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the logical AND of all values present in a given expression | | bool_or(...) | bool_or(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the logical OR of all values present in a given expression | | close(...) | close(self: _duckdb.DuckDBPyRelation) -> None | | Closes the result | | count(...) | count(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the number of elements present in a given expression | | create(...) | create(self: _duckdb.DuckDBPyRelation, table_name: str) -> None | | Creates a new table named table_name with the contents of the relation object | | create_view(...) | create_view(self: _duckdb.DuckDBPyRelation, view_name: str, replace: bool = True) -> _duckdb.DuckDBPyRelation | | Creates a view named view_name that refers to the relation object | | cross(...) | cross(self: _duckdb.DuckDBPyRelation, other_rel: _duckdb.DuckDBPyRelation) -> _duckdb.DuckDBPyRelation | | Create cross/cartesian product of two relational objects | | cume_dist(...) | cume_dist(self: _duckdb.DuckDBPyRelation, window_spec: str, projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the cumulative distribution within the partition | | dense_rank(...) | dense_rank(self: _duckdb.DuckDBPyRelation, window_spec: str, projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the dense rank within the partition | | describe(...) | describe(self: _duckdb.DuckDBPyRelation) -> _duckdb.DuckDBPyRelation | | Gives basic statistics (e.g., min, max) and if NULL exists for each column of the relation. | | df(...) | df(self: _duckdb.DuckDBPyRelation, *, date_as_object: bool = False) -> pandas.DataFrame | | Execute and fetch all rows as a pandas DataFrame | | distinct(...) | distinct(self: _duckdb.DuckDBPyRelation) -> _duckdb.DuckDBPyRelation | | Retrieve distinct rows from this relation object | | except_(...) | except_(self: _duckdb.DuckDBPyRelation, other_rel: _duckdb.DuckDBPyRelation) -> _duckdb.DuckDBPyRelation | | Create the set except of this relation object with another relation object in other_rel | | execute(...) | execute(self: _duckdb.DuckDBPyRelation) -> _duckdb.DuckDBPyRelation | | Transform the relation into a result set | | explain(...) | explain(self: _duckdb.DuckDBPyRelation, type: _duckdb.ExplainType = 'standard') -> str | | favg(...) | favg(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the average of all values present in a given expression using a more accurate floating point summation (Kahan Sum) | | fetch_arrow_reader(...) | fetch_arrow_reader(self: object, batch_size: typing.SupportsInt | typing.SupportsIndex = 1000000) -> object | | Execute and return an Arrow Record Batch Reader that yields all rows | | fetch_arrow_table(...) | fetch_arrow_table(self: object, batch_size: typing.SupportsInt | typing.SupportsIndex = 1000000) -> object | | Execute and fetch all rows as an Arrow Table | | fetch_df_chunk(...) | fetch_df_chunk(self: _duckdb.DuckDBPyRelation, vectors_per_chunk: typing.SupportsInt | typing.SupportsIndex = 1, *, date_as_object: bool = False) -> pandas.DataFrame | | Execute and fetch a chunk of the rows | | fetch_record_batch(...) | fetch_record_batch(self: object, rows_per_batch: typing.SupportsInt | typing.SupportsIndex = 1000000) -> object | | Execute and return an Arrow Record Batch Reader that yields all rows | | fetchall(...) | fetchall(self: _duckdb.DuckDBPyRelation) -> list | | Execute and fetch all rows as a list of tuples | | fetchdf(...) | fetchdf(self: _duckdb.DuckDBPyRelation, *, date_as_object: bool = False) -> pandas.DataFrame | | Execute and fetch all rows as a pandas DataFrame | | fetchmany(...) | fetchmany(self: _duckdb.DuckDBPyRelation, size: typing.SupportsInt | typing.SupportsIndex = 1) -> list | | Execute and fetch the next set of rows as a list of tuples | | fetchnumpy(...) | fetchnumpy(self: _duckdb.DuckDBPyRelation) -> dict | | Execute and fetch all rows as a Python dict mapping each column to one numpy arrays | | fetchone(...) | fetchone(self: _duckdb.DuckDBPyRelation) -> typing.Optional[tuple] | | Execute and fetch a single row as a tuple | | filter(...) | filter(self: _duckdb.DuckDBPyRelation, filter_expr: object) -> _duckdb.DuckDBPyRelation | | Filter the relation object by the filter in filter_expr | | first(...) | first(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Returns the first value of a given expression | | first_value(...) | first_value(self: _duckdb.DuckDBPyRelation, expression: str, window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the first value within the group or partition | | fsum(...) | fsum(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the sum of all values present in a given expression using a more accurate floating point summation (Kahan Sum) | | geomean(...) | geomean(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the geometric mean over all values present in a given expression | | histogram(...) | histogram(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the histogram over all values present in a given expression | | insert(...) | insert(self: _duckdb.DuckDBPyRelation, values: object) -> None | | Inserts the given values into the relation | | insert_into(...) | insert_into(self: _duckdb.DuckDBPyRelation, table_name: str) -> None | | Inserts the relation object into an existing table named table_name | | intersect(...) | intersect(self: _duckdb.DuckDBPyRelation, other_rel: _duckdb.DuckDBPyRelation) -> _duckdb.DuckDBPyRelation | | Create the set intersection of this relation object with another relation object in other_rel | | join(...) | join(self: _duckdb.DuckDBPyRelation, other_rel: _duckdb.DuckDBPyRelation, condition: object, how: str = 'inner') -> _duckdb.DuckDBPyRelation | | Join the relation object with another relation object in other_rel using the join condition expression in join_condition. Types supported are 'inner', 'left', 'right', 'outer', 'semi' and 'anti' | | lag(...) | lag(self: _duckdb.DuckDBPyRelation, expression: str, window_spec: str, offset: typing.SupportsInt | typing.SupportsIndex = 1, default_value: str = 'NULL', ignore_nulls: bool = False, projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the lag within the partition | | last(...) | last(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Returns the last value of a given expression | | last_value(...) | last_value(self: _duckdb.DuckDBPyRelation, expression: str, window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the last value within the group or partition | | lead(...) | lead(self: _duckdb.DuckDBPyRelation, expression: str, window_spec: str, offset: typing.SupportsInt | typing.SupportsIndex = 1, default_value: str = 'NULL', ignore_nulls: bool = False, projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the lead within the partition | | limit(...) | limit(self: _duckdb.DuckDBPyRelation, n: typing.SupportsInt | typing.SupportsIndex, offset: typing.SupportsInt | typing.SupportsIndex = 0) -> _duckdb.DuckDBPyRelation | | Only retrieve the first n rows from this relation object, starting at offset | | list(...) | list(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Returns a list containing all values present in a given expression | | map(...) | map(self: _duckdb.DuckDBPyRelation, map_function: collections.abc.Callable, *, schema: typing.Optional[object] = None) -> _duckdb.DuckDBPyRelation | | Calls the passed function on the relation | | max(...) | max(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Returns the maximum value present in a given expression | | mean(...) | mean(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the average of a given expression | | median(...) | median(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the median over all values present in a given expression | | min(...) | min(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Returns the minimum value present in a given expression | | mode(...) | mode(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the mode over all values present in a given expression | | n_tile(...) | n_tile(self: _duckdb.DuckDBPyRelation, window_spec: str, num_buckets: typing.SupportsInt | typing.SupportsIndex, projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Divides the partition as equally as possible into num_buckets | | nth_value(...) | nth_value(self: _duckdb.DuckDBPyRelation, expression: str, window_spec: str, offset: typing.SupportsInt | typing.SupportsIndex, ignore_nulls: bool = False, projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the nth value within the partition | | order(...) | order(self: _duckdb.DuckDBPyRelation, order_expr: str) -> _duckdb.DuckDBPyRelation | | Reorder the relation object by order_expr | | percent_rank(...) | percent_rank(self: _duckdb.DuckDBPyRelation, window_spec: str, projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the relative rank within the partition | | pl(...) | pl(self: _duckdb.DuckDBPyRelation, batch_size: typing.SupportsInt | typing.SupportsIndex = 1000000, *, lazy: bool = False) -> duckdb::PolarsDataFrame | | Execute and fetch all rows as a Polars DataFrame | | product(...) | product(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Returns the product of all values present in a given expression | | project(...) | project(self: _duckdb.DuckDBPyRelation, *args, groups: str = '') -> _duckdb.DuckDBPyRelation | | Project the relation object by the projection in project_expr | | quantile(...) | quantile(self: _duckdb.DuckDBPyRelation, expression: str, q: object = 0.5, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the exact quantile value for a given expression | | quantile_cont(...) | quantile_cont(self: _duckdb.DuckDBPyRelation, expression: str, q: object = 0.5, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the interpolated quantile value for a given expression | | quantile_disc(...) | quantile_disc(self: _duckdb.DuckDBPyRelation, expression: str, q: object = 0.5, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the exact quantile value for a given expression | | query(...) | query(self: _duckdb.DuckDBPyRelation, virtual_table_name: str, sql_query: str) -> _duckdb.DuckDBPyRelation | | Run the given SQL query in sql_query on the view named virtual_table_name that refers to the relation object | | rank(...) | rank(self: _duckdb.DuckDBPyRelation, window_spec: str, projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the rank within the partition | | rank_dense(...) | rank_dense(self: _duckdb.DuckDBPyRelation, window_spec: str, projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the dense rank within the partition | | row_number(...) | row_number(self: _duckdb.DuckDBPyRelation, window_spec: str, projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the row number within the partition | | select(...) | select(self: _duckdb.DuckDBPyRelation, *args, groups: str = '') -> _duckdb.DuckDBPyRelation | | Project the relation object by the projection in project_expr | | select_dtypes(...) | select_dtypes(self: _duckdb.DuckDBPyRelation, types: object) -> _duckdb.DuckDBPyRelation | | Select columns from the relation, by filtering based on type(s) | | select_types(...) | select_types(self: _duckdb.DuckDBPyRelation, types: object) -> _duckdb.DuckDBPyRelation | | Select columns from the relation, by filtering based on type(s) | | set_alias(...) | set_alias(self: _duckdb.DuckDBPyRelation, alias: str) -> _duckdb.DuckDBPyRelation | | Rename the relation object to new alias | | show(...) | show(self: _duckdb.DuckDBPyRelation, *, max_width: typing.Optional[int] = None, max_rows: typing.Optional[int] = None, max_col_width: typing.Optional[int] = None, null_value: typing.Optional[str] = None, render_mode: object = None) -> None | | Display a summary of the data | | sort(...) | sort(self: _duckdb.DuckDBPyRelation, *args) -> _duckdb.DuckDBPyRelation | | Reorder the relation object by the provided expressions | | sql_query(...) | sql_query(self: _duckdb.DuckDBPyRelation) -> str | | Get the SQL query that is equivalent to the relation | | std(...) | std(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the sample standard deviation for a given expression | | stddev(...) | stddev(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the sample standard deviation for a given expression | | stddev_pop(...) | stddev_pop(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the population standard deviation for a given expression | | stddev_samp(...) | stddev_samp(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the sample standard deviation for a given expression | | string_agg(...) | string_agg(self: _duckdb.DuckDBPyRelation, expression: str, sep: str = ',', groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Concatenates the values present in a given expression with a separator | | sum(...) | sum(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the sum of all values present in a given expression | | tf(...) | tf(self: _duckdb.DuckDBPyRelation) -> dict | | Fetch a result as dict of TensorFlow Tensors | | to_arrow_reader(...) | to_arrow_reader(self: _duckdb.DuckDBPyRelation, batch_size: typing.SupportsInt | typing.SupportsIndex = 1000000) -> pyarrow.lib.RecordBatchReader | | Execute and return an Arrow Record Batch Reader that yields all rows | | to_arrow_table(...) | to_arrow_table(self: _duckdb.DuckDBPyRelation, batch_size: typing.SupportsInt | typing.SupportsIndex = 1000000) -> pyarrow.lib.Table | | Execute and fetch all rows as an Arrow Table | | to_csv(...) | to_csv(self: _duckdb.DuckDBPyRelation, file_name: str, *, sep: object = None, na_rep: object = None, header: object = None, quotechar: object = None, escapechar: object = None, date_format: object = None, timestamp_format: object = None, quoting: object = None, encoding: object = None, compression: object = None, overwrite: object = None, per_thread_output: object = None, use_tmp_file: object = None, partition_by: object = None, write_partition_columns: object = None) -> None | | Write the relation object to a CSV file in 'file_name' | | to_df(...) | to_df(self: _duckdb.DuckDBPyRelation, *, date_as_object: bool = False) -> pandas.DataFrame | | Execute and fetch all rows as a pandas DataFrame | | to_parquet(...) | to_parquet(self: _duckdb.DuckDBPyRelation, file_name: str, *, compression: object = None, field_ids: object = None, row_group_size_bytes: object = None, row_group_size: object = None, overwrite: object = None, per_thread_output: object = None, use_tmp_file: object = None, partition_by: object = None, write_partition_columns: object = None, append: object = None, filename_pattern: object = None, file_size_bytes: object = None) -> None | | Write the relation object to a Parquet file in 'file_name' | | to_table(...) | to_table(self: _duckdb.DuckDBPyRelation, table_name: str) -> None | | Creates a new table named table_name with the contents of the relation object | | to_view(...) | to_view(self: _duckdb.DuckDBPyRelation, view_name: str, replace: bool = True) -> _duckdb.DuckDBPyRelation | | Creates a view named view_name that refers to the relation object | | torch(...) | torch(self: _duckdb.DuckDBPyRelation) -> dict | | Fetch a result as dict of PyTorch Tensors | | union(...) | union(self: _duckdb.DuckDBPyRelation, union_rel: _duckdb.DuckDBPyRelation) -> _duckdb.DuckDBPyRelation | | Create the set union of this relation object with another relation object in other_rel | | unique(...) | unique(self: _duckdb.DuckDBPyRelation, unique_aggr: str) -> _duckdb.DuckDBPyRelation | | Returns the distinct values in a column. | | update(...) | update(self: _duckdb.DuckDBPyRelation, set: object, *, condition: object = None) -> None | | Update the given relation with the provided expressions | | value_counts(...) | value_counts(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '') -> _duckdb.DuckDBPyRelation | | Computes the number of elements present in a given expression, also projecting the original expression | | var(...) | var(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the sample variance for a given expression | | var_pop(...) | var_pop(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the population variance for a given expression | | var_samp(...) | var_samp(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the sample variance for a given expression | | variance(...) | variance(self: _duckdb.DuckDBPyRelation, expression: str, groups: str = '', window_spec: str = '', projected_columns: str = '') -> _duckdb.DuckDBPyRelation | | Computes the sample variance for a given expression | | write_csv(...) | write_csv(self: _duckdb.DuckDBPyRelation, file_name: str, *, sep: object = None, na_rep: object = None, header: object = None, quotechar: object = None, escapechar: object = None, date_format: object = None, timestamp_format: object = None, quoting: object = None, encoding: object = None, compression: object = None, overwrite: object = None, per_thread_output: object = None, use_tmp_file: object = None, partition_by: object = None, write_partition_columns: object = None) -> None | | Write the relation object to a CSV file in 'file_name' | | write_parquet(...) | write_parquet(self: _duckdb.DuckDBPyRelation, file_name: str, *, compression: object = None, field_ids: object = None, row_group_size_bytes: object = None, row_group_size: object = None, overwrite: object = None, per_thread_output: object = None, use_tmp_file: object = None, partition_by: object = None, write_partition_columns: object = None, append: object = None, filename_pattern: object = None, file_size_bytes: object = None) -> None | | Write the relation object to a Parquet file in 'file_name' | | ---------------------------------------------------------------------- | Readonly properties defined here: | | alias | Get the name of the current alias | | columns | Return a list containing the names of the columns of the relation. | | description | Return the description of the result | | dtypes | Return a list containing the types of the columns of the relation. | | shape | Tuple of # of rows, # of columns in relation. | | type | Get the type of the relation. | | types | Return a list containing the types of the columns of the relation. | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __pybind11_module_local_v11_msvc_mt_mscver1944__ = <capsule object NUL... | | ---------------------------------------------------------------------- | Static methods inherited from pybind11_builtins.pybind11_object: | | __new__(*args, **kwargs) class method of pybind11_builtins.pybind11_object | Create and return a new object. See help(type) for accurate signature.
duckdb.Error
Python Library Documentation: class Error in module _duckdb class Error(builtins.Exception) | Method resolution order: | Error | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors defined here: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) class method of builtins.Exception | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args
duckdb.ExpectedResultType
Python Library Documentation: class ExpectedResultType in module _duckdb class ExpectedResultType(pybind11_builtins.pybind11_object) | Method resolution order: | ExpectedResultType | pybind11_builtins.pybind11_object | builtins.object | | Methods defined here: | | __eq__(...) | __eq__(self: object, other: object, /) -> bool | | __getstate__(...) | __getstate__(self: object, /) -> int | | __hash__(...) | __hash__(self: object, /) -> int | | __index__(...) | __index__(self: _duckdb.ExpectedResultType, /) -> int | | __init__(...) | __init__(self: _duckdb.ExpectedResultType, value: typing.SupportsInt | typing.SupportsIndex) -> None | | __int__(...) | __int__(self: _duckdb.ExpectedResultType, /) -> int | | __ne__(...) | __ne__(self: object, other: object, /) -> bool | | __repr__(...) | __repr__(self: object, /) -> str | | __setstate__(...) | __setstate__(self: _duckdb.ExpectedResultType, state: typing.SupportsInt | typing.SupportsIndex, /) -> None | | __str__(...) | __str__(self: object, /) -> str | | ---------------------------------------------------------------------- | Readonly properties defined here: | | __members__ | | name | name(self: object, /) -> str | | value | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | CHANGED_ROWS = <ExpectedResultType.CHANGED_ROWS: 1> | | NOTHING = <ExpectedResultType.NOTHING: 2> | | QUERY_RESULT = <ExpectedResultType.QUERY_RESULT: 0> | | ---------------------------------------------------------------------- | Static methods inherited from pybind11_builtins.pybind11_object: | | __new__(*args, **kwargs) class method of pybind11_builtins.pybind11_object | Create and return a new object. See help(type) for accurate signature.
duckdb.ExplainType
Python Library Documentation: class ExplainType in module _duckdb class ExplainType(pybind11_builtins.pybind11_object) | Method resolution order: | ExplainType | pybind11_builtins.pybind11_object | builtins.object | | Methods defined here: | | __eq__(...) | __eq__(self: object, other: object, /) -> bool | | __getstate__(...) | __getstate__(self: object, /) -> int | | __hash__(...) | __hash__(self: object, /) -> int | | __index__(...) | __index__(self: _duckdb.ExplainType, /) -> int | | __init__(...) | __init__(self: _duckdb.ExplainType, value: typing.SupportsInt | typing.SupportsIndex) -> None | | __int__(...) | __int__(self: _duckdb.ExplainType, /) -> int | | __ne__(...) | __ne__(self: object, other: object, /) -> bool | | __repr__(...) | __repr__(self: object, /) -> str | | __setstate__(...) | __setstate__(self: _duckdb.ExplainType, state: typing.SupportsInt | typing.SupportsIndex, /) -> None | | __str__(...) | __str__(self: object, /) -> str | | ---------------------------------------------------------------------- | Readonly properties defined here: | | __members__ | | name | name(self: object, /) -> str | | value | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | ANALYZE = <ExplainType.ANALYZE: 1> | | STANDARD = <ExplainType.STANDARD: 0> | | ---------------------------------------------------------------------- | Static methods inherited from pybind11_builtins.pybind11_object: | | __new__(*args, **kwargs) class method of pybind11_builtins.pybind11_object | Create and return a new object. See help(type) for accurate signature.
duckdb.Expression
Python Library Documentation: class Expression in module _duckdb class Expression(pybind11_builtins.pybind11_object) | Method resolution order: | Expression | pybind11_builtins.pybind11_object | builtins.object | | Methods defined here: | | __add__(...) | __add__(self: _duckdb.Expression, expr: _duckdb.Expression) -> _duckdb.Expression | | | Add expr to self | | Parameters: | expr: The expression to add together with | | Returns: | FunctionExpression: self '+' expr | | __and__(...) | __and__(self: _duckdb.Expression, arg0: _duckdb.Expression) -> _duckdb.Expression | | | Binary-and self together with expr | | Parameters: | expr: The expression to AND together with self | | Returns: | FunctionExpression: self '&' expr | | __div__(...) | __div__(self: _duckdb.Expression, arg0: _duckdb.Expression) -> _duckdb.Expression | | | Divide self by expr | | Parameters: | expr: The expression to divide by | | Returns: | FunctionExpression: self '/' expr | | __eq__(...) | __eq__(self: _duckdb.Expression, arg0: _duckdb.Expression) -> _duckdb.Expression | | | Create an equality expression between two expressions | | Parameters: | expr: The expression to check equality with | | Returns: | FunctionExpression: self '=' expr | | __floordiv__(...) | __floordiv__(self: _duckdb.Expression, arg0: _duckdb.Expression) -> _duckdb.Expression | | | (Floor) Divide self by expr | | Parameters: | expr: The expression to (floor) divide by | | Returns: | FunctionExpression: self '//' expr | | __ge__(...) | __ge__(self: _duckdb.Expression, arg0: _duckdb.Expression) -> _duckdb.Expression | | | Create a greater than or equal expression between two expressions | | Parameters: | expr: The expression to check | | Returns: | FunctionExpression: self '>=' expr | | __gt__(...) | __gt__(self: _duckdb.Expression, arg0: _duckdb.Expression) -> _duckdb.Expression | | | Create a greater than expression between two expressions | | Parameters: | expr: The expression to check | | Returns: | FunctionExpression: self '>' expr | | __init__(...) | __init__(*args, **kwargs) | Overloaded function. | | 1. __init__(self: _duckdb.Expression, arg0: str) -> None | | 2. __init__(self: _duckdb.Expression, arg0: object) -> None | | __invert__(...) | __invert__(self: _duckdb.Expression) -> _duckdb.Expression | | | Create a binary-not expression from self | | Returns: | FunctionExpression: ~self | | __le__(...) | __le__(self: _duckdb.Expression, arg0: _duckdb.Expression) -> _duckdb.Expression | | | Create a less than or equal expression between two expressions | | Parameters: | expr: The expression to check | | Returns: | FunctionExpression: self '<=' expr | | __lt__(...) | __lt__(self: _duckdb.Expression, arg0: _duckdb.Expression) -> _duckdb.Expression | | | Create a less than expression between two expressions | | Parameters: | expr: The expression to check | | Returns: | FunctionExpression: self '<' expr | | __mod__(...) | __mod__(self: _duckdb.Expression, arg0: _duckdb.Expression) -> _duckdb.Expression | | | Modulo self by expr | | Parameters: | expr: The expression to modulo by | | Returns: | FunctionExpression: self '%' expr | | __mul__(...) | __mul__(self: _duckdb.Expression, arg0: _duckdb.Expression) -> _duckdb.Expression | | | Multiply self by expr | | Parameters: | expr: The expression to multiply by | | Returns: | FunctionExpression: self '*' expr | | __ne__(...) | __ne__(self: _duckdb.Expression, arg0: _duckdb.Expression) -> _duckdb.Expression | | | Create an inequality expression between two expressions | | Parameters: | expr: The expression to check inequality with | | Returns: | FunctionExpression: self '!=' expr | | __neg__(...) | __neg__(self: _duckdb.Expression) -> _duckdb.Expression | | | Negate the expression. | | Returns: | FunctionExpression: -self | | __or__(...) | __or__(self: _duckdb.Expression, arg0: _duckdb.Expression) -> _duckdb.Expression | | | Binary-or self together with expr | | Parameters: | expr: The expression to OR together with self | | Returns: | FunctionExpression: self '|' expr | | __pow__(...) | __pow__(self: _duckdb.Expression, arg0: _duckdb.Expression) -> _duckdb.Expression | | | Power self by expr | | Parameters: | expr: The expression to power by | | Returns: | FunctionExpression: self '**' expr | | __radd__(...) | __radd__(self: _duckdb.Expression, arg0: _duckdb.Expression) -> _duckdb.Expression | | | Add expr to self | | Parameters: | expr: The expression to add together with | | Returns: | FunctionExpression: self '+' expr | | __rand__(...) | __rand__(self: _duckdb.Expression, arg0: _duckdb.Expression) -> _duckdb.Expression | | | Binary-and self together with expr | | Parameters: | expr: The expression to AND together with self | | Returns: | FunctionExpression: expr '&' self | | __rdiv__(...) | __rdiv__(self: _duckdb.Expression, arg0: _duckdb.Expression) -> _duckdb.Expression | | | Divide self by expr | | Parameters: | expr: The expression to divide by | | Returns: | FunctionExpression: self '/' expr | | __repr__(...) | __repr__(self: _duckdb.Expression) -> str | | | Return the stringified version of the expression. | | Returns: | str: The string representation. | | __rfloordiv__(...) | __rfloordiv__(self: _duckdb.Expression, arg0: _duckdb.Expression) -> _duckdb.Expression | | | (Floor) Divide self by expr | | Parameters: | expr: The expression to (floor) divide by | | Returns: | FunctionExpression: self '//' expr | | __rmod__(...) | __rmod__(self: _duckdb.Expression, arg0: _duckdb.Expression) -> _duckdb.Expression | | | Modulo self by expr | | Parameters: | expr: The expression to modulo by | | Returns: | FunctionExpression: self '%' expr | | __rmul__(...) | __rmul__(self: _duckdb.Expression, arg0: _duckdb.Expression) -> _duckdb.Expression | | | Multiply self by expr | | Parameters: | expr: The expression to multiply by | | Returns: | FunctionExpression: self '*' expr | | __ror__(...) | __ror__(self: _duckdb.Expression, arg0: _duckdb.Expression) -> _duckdb.Expression | | | Binary-or self together with expr | | Parameters: | expr: The expression to OR together with self | | Returns: | FunctionExpression: expr '|' self | | __rpow__(...) | __rpow__(self: _duckdb.Expression, arg0: _duckdb.Expression) -> _duckdb.Expression | | | Power self by expr | | Parameters: | expr: The expression to power by | | Returns: | FunctionExpression: self '**' expr | | __rsub__(...) | __rsub__(self: _duckdb.Expression, arg0: _duckdb.Expression) -> _duckdb.Expression | | | Subtract expr from self | | Parameters: | expr: The expression to subtract from | | Returns: | FunctionExpression: self '-' expr | | __rtruediv__(...) | __rtruediv__(self: _duckdb.Expression, arg0: _duckdb.Expression) -> _duckdb.Expression | | | Divide self by expr | | Parameters: | expr: The expression to divide by | | Returns: | FunctionExpression: self '/' expr | | __sub__(...) | __sub__(self: _duckdb.Expression, arg0: _duckdb.Expression) -> _duckdb.Expression | | | Subtract expr from self | | Parameters: | expr: The expression to subtract from | | Returns: | FunctionExpression: self '-' expr | | __truediv__(...) | __truediv__(self: _duckdb.Expression, arg0: _duckdb.Expression) -> _duckdb.Expression | | | Divide self by expr | | Parameters: | expr: The expression to divide by | | Returns: | FunctionExpression: self '/' expr | | alias(...) | alias(self: _duckdb.Expression, arg0: str) -> _duckdb.Expression | | | Create a copy of this expression with the given alias. | | Parameters: | name: The alias to use for the expression, this will affect how it can be referenced. | | Returns: | Expression: self with an alias. | | asc(...) | asc(self: _duckdb.Expression) -> _duckdb.Expression | | | Set the order by modifier to ASCENDING. | | between(...) | between(self: _duckdb.Expression, lower: _duckdb.Expression, upper: _duckdb.Expression) -> _duckdb.Expression | | cast(...) | cast(self: _duckdb.Expression, type: _duckdb._sqltypes.DuckDBPyType) -> _duckdb.Expression | | | Create a CastExpression to type from self | | Parameters: | type: The type to cast to | | Returns: | CastExpression: self::type | | collate(...) | collate(self: _duckdb.Expression, collation: str) -> _duckdb.Expression | | desc(...) | desc(self: _duckdb.Expression) -> _duckdb.Expression | | | Set the order by modifier to DESCENDING. | | get_name(...) | get_name(self: _duckdb.Expression) -> str | | | Return the stringified version of the expression. | | Returns: | str: The string representation. | | isin(...) | isin(self: _duckdb.Expression, *args) -> _duckdb.Expression | | | Return an IN expression comparing self to the input arguments. | | Returns: | DuckDBPyExpression: The compare IN expression | | isnotin(...) | isnotin(self: _duckdb.Expression, *args) -> _duckdb.Expression | | | Return a NOT IN expression comparing self to the input arguments. | | Returns: | DuckDBPyExpression: The compare NOT IN expression | | isnotnull(...) | isnotnull(self: _duckdb.Expression) -> _duckdb.Expression | | | Create a binary IS NOT NULL expression from self | | Returns: | DuckDBPyExpression: self IS NOT NULL | | isnull(...) | isnull(self: _duckdb.Expression) -> _duckdb.Expression | | | Create a binary IS NULL expression from self | | Returns: | DuckDBPyExpression: self IS NULL | | nulls_first(...) | nulls_first(self: _duckdb.Expression) -> _duckdb.Expression | | | Set the NULL order by modifier to NULLS FIRST. | | nulls_last(...) | nulls_last(self: _duckdb.Expression) -> _duckdb.Expression | | | Set the NULL order by modifier to NULLS LAST. | | otherwise(...) | otherwise(self: _duckdb.Expression, value: _duckdb.Expression) -> _duckdb.Expression | | | Add an ELSE <value> clause to the CaseExpression. | | Parameters: | value: The value to use if none of the WHEN conditions are met. | | Returns: | CaseExpression: self with an ELSE clause. | | show(...) | show(self: _duckdb.Expression) -> None | | | Print the stringified version of the expression. | | when(...) | when(self: _duckdb.Expression, condition: _duckdb.Expression, value: _duckdb.Expression) -> _duckdb.Expression | | | Add an additional WHEN <condition> THEN <value> clause to the CaseExpression. | | Parameters: | condition: The condition that must be met. | value: The value to use if the condition is met. | | Returns: | CaseExpression: self with an additional WHEN clause. | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __hash__ = None | | __pybind11_module_local_v11_msvc_mt_mscver1944__ = <capsule object NUL... | | ---------------------------------------------------------------------- | Static methods inherited from pybind11_builtins.pybind11_object: | | __new__(*args, **kwargs) class method of pybind11_builtins.pybind11_object | Create and return a new object. See help(type) for accurate signature.
duckdb.FatalException
Python Library Documentation: class FatalException in module _duckdb class FatalException(DatabaseError) | Method resolution order: | FatalException | DatabaseError | Error | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors inherited from Error: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) class method of builtins.Exception | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args
duckdb.FloatValue
Python Library Documentation: class FloatValue in module duckdb.value.constant class FloatValue(Value) | FloatValue(object: Any) -> None | | Method resolution order: | FloatValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.FunctionExpression
Python Library Documentation: built-in function FunctionExpression in module _duckdb
FunctionExpression(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
FunctionExpression(function_name: str, *args) -> _duckdb.Expression
duckdb.HTTPException
Python Library Documentation: class HTTPException in module _duckdb
class HTTPException(IOException)
| Thrown when an error occurs in the httpfs extension, or whilst downloading an extension.
|
| Method resolution order:
| HTTPException
| IOException
| OperationalError
| DatabaseError
| Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {'body': <class 'str'>, 'headers': typing.Dict[str, ...
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
duckdb.HugeIntegerValue
Python Library Documentation: class HugeIntegerValue in module duckdb.value.constant class HugeIntegerValue(Value) | HugeIntegerValue(object: Any) -> None | | Method resolution order: | HugeIntegerValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.IOException
Python Library Documentation: class IOException in module _duckdb
class IOException(OperationalError)
| Method resolution order:
| IOException
| OperationalError
| DatabaseError
| Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
duckdb.IntegerValue
Python Library Documentation: class IntegerValue in module duckdb.value.constant class IntegerValue(Value) | IntegerValue(object: Any) -> None | | Method resolution order: | IntegerValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.IntegrityError
Python Library Documentation: class IntegrityError in module _duckdb
class IntegrityError(DatabaseError)
| Method resolution order:
| IntegrityError
| DatabaseError
| Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
duckdb.InternalError
Python Library Documentation: class InternalError in module _duckdb
class InternalError(DatabaseError)
| Method resolution order:
| InternalError
| DatabaseError
| Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
duckdb.InternalException
Python Library Documentation: class InternalException in module _duckdb
class InternalException(InternalError)
| Method resolution order:
| InternalException
| InternalError
| DatabaseError
| Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
duckdb.InterruptException
Python Library Documentation: class InterruptException in module _duckdb
class InterruptException(DatabaseError)
| Method resolution order:
| InterruptException
| DatabaseError
| Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
duckdb.IntervalValue
Python Library Documentation: class IntervalValue in module duckdb.value.constant class IntervalValue(Value) | IntervalValue(object: Any) -> None | | Method resolution order: | IntervalValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.InvalidInputException
Python Library Documentation: class InvalidInputException in module _duckdb
class InvalidInputException(ProgrammingError)
| Method resolution order:
| InvalidInputException
| ProgrammingError
| DatabaseError
| Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
duckdb.InvalidTypeException
Python Library Documentation: class InvalidTypeException in module _duckdb
class InvalidTypeException(ProgrammingError)
| Method resolution order:
| InvalidTypeException
| ProgrammingError
| DatabaseError
| Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
duckdb.LambdaExpression
Python Library Documentation: built-in function LambdaExpression in module _duckdb
LambdaExpression(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
LambdaExpression(lhs: object, rhs: _duckdb.Expression) -> _duckdb.Expression
duckdb.ListValue
Python Library Documentation: class ListValue in module duckdb.value.constant class ListValue(Value) | ListValue(object: Any, child_type: _duckdb._sqltypes.DuckDBPyType) -> None | | Method resolution order: | ListValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any, child_type: _duckdb._sqltypes.DuckDBPyType) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.LongValue
Python Library Documentation: class LongValue in module duckdb.value.constant class LongValue(Value) | LongValue(object: Any) -> None | | Method resolution order: | LongValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.MapValue
Python Library Documentation: class MapValue in module duckdb.value.constant class MapValue(Value) | MapValue(object: Any, key_type: _duckdb._sqltypes.DuckDBPyType, value_type: _duckdb._sqltypes.DuckDBPyType) -> None | | Method resolution order: | MapValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any, key_type: _duckdb._sqltypes.DuckDBPyType, value_type: _duckdb._sqltypes.DuckDBPyType) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.NUMBER
Python Library Documentation: DBAPITypeObject in module duckdb._dbapi_type_object object class DBAPITypeObject(builtins.object) | DBAPITypeObject(types: list[_duckdb._sqltypes.DuckDBPyType]) -> None | | DB API 2.0 type object for categorizing database column types. | | This class implements the type objects defined in PEP 249 (DB API 2.0). | It allows checking whether a specific DuckDB type belongs to a broader | category like STRING, NUMBER, DATETIME, etc. | | The type object supports equality comparison with DuckDBPyType instances, | returning True if the type belongs to this category. | | Args: | types: A list of DuckDBPyType instances that belong to this type category. | | Example: | >>> string_types = DBAPITypeObject([sqltypes.VARCHAR, sqltypes.CHAR]) | >>> result = sqltypes.VARCHAR == string_types # True | >>> result = sqltypes.INTEGER == string_types # False | | Note: | This follows the DB API 2.0 specification where type objects are compared | using equality operators rather than isinstance() checks. | | Methods defined here: | | __eq__(self, other: object) -> bool | Check if a DuckDB type belongs to this type category. | | This method implements the DB API 2.0 type checking mechanism. | It returns True if the other object is a DuckDBPyType that | is contained in this type category. | | Args: | other: The object to compare, typically a DuckDBPyType instance. | | Returns: | True if other is a DuckDBPyType in this category, False otherwise. | | Example: | >>> NUMBER == sqltypes.INTEGER # True | >>> NUMBER == sqltypes.VARCHAR # False | | __init__(self, types: list[_duckdb._sqltypes.DuckDBPyType]) -> None | Initialize a DB API type object. | | Args: | types: List of DuckDB types that belong to this category. | | __repr__(self) -> str | Return a string representation of this type object. | | Returns: | A string showing the type object and its contained DuckDB types. | | Example: | >>> repr(STRING) | '<DBAPITypeObject [VARCHAR]>' | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __hash__ = None
duckdb.NotImplementedException
Python Library Documentation: class NotImplementedException in module _duckdb
class NotImplementedException(NotSupportedError)
| Method resolution order:
| NotImplementedException
| NotSupportedError
| DatabaseError
| Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
duckdb.NotSupportedError
Python Library Documentation: class NotSupportedError in module _duckdb
class NotSupportedError(DatabaseError)
| Method resolution order:
| NotSupportedError
| DatabaseError
| Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
duckdb.NullValue
Python Library Documentation: class NullValue in module duckdb.value.constant class NullValue(Value) | NullValue() -> None | | Method resolution order: | NullValue | Value | builtins.object | | Methods defined here: | | __init__(self) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.OperationalError
Python Library Documentation: class OperationalError in module _duckdb
class OperationalError(DatabaseError)
| Method resolution order:
| OperationalError
| DatabaseError
| Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
duckdb.OutOfMemoryException
Python Library Documentation: class OutOfMemoryException in module _duckdb
class OutOfMemoryException(OperationalError)
| Method resolution order:
| OutOfMemoryException
| OperationalError
| DatabaseError
| Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
duckdb.OutOfRangeException
Python Library Documentation: class OutOfRangeException in module _duckdb
class OutOfRangeException(DataError)
| Method resolution order:
| OutOfRangeException
| DataError
| DatabaseError
| Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
duckdb.ParserException
Python Library Documentation: class ParserException in module _duckdb
class ParserException(ProgrammingError)
| Method resolution order:
| ParserException
| ProgrammingError
| DatabaseError
| Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
duckdb.PermissionException
Python Library Documentation: class PermissionException in module _duckdb
class PermissionException(DatabaseError)
| Method resolution order:
| PermissionException
| DatabaseError
| Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
duckdb.ProgrammingError
Python Library Documentation: class ProgrammingError in module _duckdb
class ProgrammingError(DatabaseError)
| Method resolution order:
| ProgrammingError
| DatabaseError
| Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
duckdb.PythonExceptionHandling
Python Library Documentation: class PythonExceptionHandling in module _duckdb class PythonExceptionHandling(pybind11_builtins.pybind11_object) | Method resolution order: | PythonExceptionHandling | pybind11_builtins.pybind11_object | builtins.object | | Methods defined here: | | __eq__(...) | __eq__(self: object, other: object, /) -> bool | | __getstate__(...) | __getstate__(self: object, /) -> int | | __hash__(...) | __hash__(self: object, /) -> int | | __index__(...) | __index__(self: _duckdb.PythonExceptionHandling, /) -> int | | __init__(...) | __init__(self: _duckdb.PythonExceptionHandling, value: typing.SupportsInt | typing.SupportsIndex) -> None | | __int__(...) | __int__(self: _duckdb.PythonExceptionHandling, /) -> int | | __ne__(...) | __ne__(self: object, other: object, /) -> bool | | __repr__(...) | __repr__(self: object, /) -> str | | __setstate__(...) | __setstate__(self: _duckdb.PythonExceptionHandling, state: typing.SupportsInt | typing.SupportsIndex, /) -> None | | __str__(...) | __str__(self: object, /) -> str | | ---------------------------------------------------------------------- | Readonly properties defined here: | | __members__ | | name | name(self: object, /) -> str | | value | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | DEFAULT = <PythonExceptionHandling.DEFAULT: 0> | | RETURN_NULL = <PythonExceptionHandling.RETURN_NULL: 1> | | ---------------------------------------------------------------------- | Static methods inherited from pybind11_builtins.pybind11_object: | | __new__(*args, **kwargs) class method of pybind11_builtins.pybind11_object | Create and return a new object. See help(type) for accurate signature.
duckdb.ROWID
Python Library Documentation: NoneType object class NoneType(object) | Methods defined here: | | __bool__(self, /) | True if self else False | | __eq__(self, value, /) | Return self==value. | | __ge__(self, value, /) | Return self>=value. | | __gt__(self, value, /) | Return self>value. | | __hash__(self, /) | Return hash(self). | | __le__(self, value, /) | Return self<=value. | | __lt__(self, value, /) | Return self<value. | | __ne__(self, value, /) | Return self!=value. | | __repr__(self, /) | Return repr(self). | | ---------------------------------------------------------------------- | Static methods defined here: | | __new__(*args, **kwargs) | Create and return a new object. See help(type) for accurate signature.
duckdb.RenderMode
Python Library Documentation: class RenderMode in module _duckdb class RenderMode(pybind11_builtins.pybind11_object) | Method resolution order: | RenderMode | pybind11_builtins.pybind11_object | builtins.object | | Methods defined here: | | __eq__(...) | __eq__(self: object, other: object, /) -> bool | | __getstate__(...) | __getstate__(self: object, /) -> int | | __hash__(...) | __hash__(self: object, /) -> int | | __index__(...) | __index__(self: _duckdb.RenderMode, /) -> int | | __init__(...) | __init__(self: _duckdb.RenderMode, value: typing.SupportsInt | typing.SupportsIndex) -> None | | __int__(...) | __int__(self: _duckdb.RenderMode, /) -> int | | __ne__(...) | __ne__(self: object, other: object, /) -> bool | | __repr__(...) | __repr__(self: object, /) -> str | | __setstate__(...) | __setstate__(self: _duckdb.RenderMode, state: typing.SupportsInt | typing.SupportsIndex, /) -> None | | __str__(...) | __str__(self: object, /) -> str | | ---------------------------------------------------------------------- | Readonly properties defined here: | | __members__ | | name | name(self: object, /) -> str | | value | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | COLUMNS = <RenderMode.COLUMNS: 1> | | ROWS = <RenderMode.ROWS: 0> | | ---------------------------------------------------------------------- | Static methods inherited from pybind11_builtins.pybind11_object: | | __new__(*args, **kwargs) class method of pybind11_builtins.pybind11_object | Create and return a new object. See help(type) for accurate signature.
duckdb.SQLExpression
Python Library Documentation: built-in function SQLExpression in module _duckdb
SQLExpression(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
SQLExpression(expression: str) -> _duckdb.Expression
duckdb.STRING
Python Library Documentation: DBAPITypeObject in module duckdb._dbapi_type_object object class DBAPITypeObject(builtins.object) | DBAPITypeObject(types: list[_duckdb._sqltypes.DuckDBPyType]) -> None | | DB API 2.0 type object for categorizing database column types. | | This class implements the type objects defined in PEP 249 (DB API 2.0). | It allows checking whether a specific DuckDB type belongs to a broader | category like STRING, NUMBER, DATETIME, etc. | | The type object supports equality comparison with DuckDBPyType instances, | returning True if the type belongs to this category. | | Args: | types: A list of DuckDBPyType instances that belong to this type category. | | Example: | >>> string_types = DBAPITypeObject([sqltypes.VARCHAR, sqltypes.CHAR]) | >>> result = sqltypes.VARCHAR == string_types # True | >>> result = sqltypes.INTEGER == string_types # False | | Note: | This follows the DB API 2.0 specification where type objects are compared | using equality operators rather than isinstance() checks. | | Methods defined here: | | __eq__(self, other: object) -> bool | Check if a DuckDB type belongs to this type category. | | This method implements the DB API 2.0 type checking mechanism. | It returns True if the other object is a DuckDBPyType that | is contained in this type category. | | Args: | other: The object to compare, typically a DuckDBPyType instance. | | Returns: | True if other is a DuckDBPyType in this category, False otherwise. | | Example: | >>> NUMBER == sqltypes.INTEGER # True | >>> NUMBER == sqltypes.VARCHAR # False | | __init__(self, types: list[_duckdb._sqltypes.DuckDBPyType]) -> None | Initialize a DB API type object. | | Args: | types: List of DuckDB types that belong to this category. | | __repr__(self) -> str | Return a string representation of this type object. | | Returns: | A string showing the type object and its contained DuckDB types. | | Example: | >>> repr(STRING) | '<DBAPITypeObject [VARCHAR]>' | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __hash__ = None
duckdb.SequenceException
Python Library Documentation: class SequenceException in module _duckdb
class SequenceException(DatabaseError)
| Method resolution order:
| SequenceException
| DatabaseError
| Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
duckdb.SerializationException
Python Library Documentation: class SerializationException in module _duckdb
class SerializationException(OperationalError)
| Method resolution order:
| SerializationException
| OperationalError
| DatabaseError
| Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
duckdb.ShortValue
Python Library Documentation: class ShortValue in module duckdb.value.constant class ShortValue(Value) | ShortValue(object: Any) -> None | | Method resolution order: | ShortValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.StarExpression
Python Library Documentation: built-in function StarExpression in module _duckdb
StarExpression(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
StarExpression(*args, **kwargs)
Overloaded function.
1. StarExpression(*, exclude: object = None) -> _duckdb.Expression
2. StarExpression() -> _duckdb.Expression
duckdb.Statement
Python Library Documentation: class Statement in module _duckdb class Statement(pybind11_builtins.pybind11_object) | Method resolution order: | Statement | pybind11_builtins.pybind11_object | builtins.object | | Methods defined here: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Readonly properties defined here: | | expected_result_type | Get the expected type of result produced by this statement, actual type may vary depending on the statement. | | named_parameters | Get the map of named parameters this statement has. | | query | Get the query equivalent to this statement. | | type | Get the type of the statement. | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __pybind11_module_local_v11_msvc_mt_mscver1944__ = <capsule object NUL... | | ---------------------------------------------------------------------- | Static methods inherited from pybind11_builtins.pybind11_object: | | __new__(*args, **kwargs) class method of pybind11_builtins.pybind11_object | Create and return a new object. See help(type) for accurate signature.
duckdb.StatementType
Python Library Documentation: class StatementType in module _duckdb class StatementType(pybind11_builtins.pybind11_object) | Method resolution order: | StatementType | pybind11_builtins.pybind11_object | builtins.object | | Methods defined here: | | __eq__(...) | __eq__(self: object, other: object, /) -> bool | | __getstate__(...) | __getstate__(self: object, /) -> int | | __hash__(...) | __hash__(self: object, /) -> int | | __index__(...) | __index__(self: _duckdb.StatementType, /) -> int | | __init__(...) | __init__(self: _duckdb.StatementType, value: typing.SupportsInt | typing.SupportsIndex) -> None | | __int__(...) | __int__(self: _duckdb.StatementType, /) -> int | | __ne__(...) | __ne__(self: object, other: object, /) -> bool | | __repr__(...) | __repr__(self: object, /) -> str | | __setstate__(...) | __setstate__(self: _duckdb.StatementType, state: typing.SupportsInt | typing.SupportsIndex, /) -> None | | __str__(...) | __str__(self: object, /) -> str | | ---------------------------------------------------------------------- | Readonly properties defined here: | | __members__ | | name | name(self: object, /) -> str | | value | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | ALTER = <StatementType.ALTER: 8> | | ANALYZE = <StatementType.ANALYZE: 11> | | ATTACH = <StatementType.ATTACH: 25> | | CALL = <StatementType.CALL: 19> | | COPY = <StatementType.COPY: 10> | | COPY_DATABASE = <StatementType.COPY_DATABASE: 28> | | CREATE = <StatementType.CREATE: 4> | | CREATE_FUNC = <StatementType.CREATE_FUNC: 13> | | DELETE = <StatementType.DELETE: 5> | | DETACH = <StatementType.DETACH: 26> | | DROP = <StatementType.DROP: 15> | | EXECUTE = <StatementType.EXECUTE: 7> | | EXPLAIN = <StatementType.EXPLAIN: 14> | | EXPORT = <StatementType.EXPORT: 16> | | EXTENSION = <StatementType.EXTENSION: 23> | | INSERT = <StatementType.INSERT: 2> | | INVALID = <StatementType.INVALID: 0> | | LOAD = <StatementType.LOAD: 21> | | LOGICAL_PLAN = <StatementType.LOGICAL_PLAN: 24> | | MERGE_INTO = <StatementType.MERGE_INTO: 30> | | MULTI = <StatementType.MULTI: 27> | | PRAGMA = <StatementType.PRAGMA: 17> | | PREPARE = <StatementType.PREPARE: 6> | | RELATION = <StatementType.RELATION: 22> | | SELECT = <StatementType.SELECT: 1> | | SET = <StatementType.SET: 20> | | TRANSACTION = <StatementType.TRANSACTION: 9> | | UPDATE = <StatementType.UPDATE: 3> | | VACUUM = <StatementType.VACUUM: 18> | | VARIABLE_SET = <StatementType.VARIABLE_SET: 12> | | ---------------------------------------------------------------------- | Static methods inherited from pybind11_builtins.pybind11_object: | | __new__(*args, **kwargs) class method of pybind11_builtins.pybind11_object | Create and return a new object. See help(type) for accurate signature.
duckdb.StringValue
Python Library Documentation: class StringValue in module duckdb.value.constant class StringValue(Value) | StringValue(object: Any) -> None | | Method resolution order: | StringValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.StructValue
Python Library Documentation: class StructValue in module duckdb.value.constant class StructValue(Value) | StructValue(object: Any, children: dict[str, _duckdb._sqltypes.DuckDBPyType]) -> None | | Method resolution order: | StructValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any, children: dict[str, _duckdb._sqltypes.DuckDBPyType]) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.SyntaxException
Python Library Documentation: class SyntaxException in module _duckdb
class SyntaxException(ProgrammingError)
| Method resolution order:
| SyntaxException
| ProgrammingError
| DatabaseError
| Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
duckdb.TimeTimeZoneValue
Python Library Documentation: class TimeTimeZoneValue in module duckdb.value.constant class TimeTimeZoneValue(Value) | TimeTimeZoneValue(object: Any) -> None | | Method resolution order: | TimeTimeZoneValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.TimeValue
Python Library Documentation: class TimeValue in module duckdb.value.constant class TimeValue(Value) | TimeValue(object: Any) -> None | | Method resolution order: | TimeValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.TimestampMillisecondValue
Python Library Documentation: class TimestampMillisecondValue in module duckdb.value.constant class TimestampMillisecondValue(Value) | TimestampMillisecondValue(object: Any) -> None | | Method resolution order: | TimestampMillisecondValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.TimestampNanosecondValue
Python Library Documentation: class TimestampNanosecondValue in module duckdb.value.constant class TimestampNanosecondValue(Value) | TimestampNanosecondValue(object: Any) -> None | | Method resolution order: | TimestampNanosecondValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.TimestampSecondValue
Python Library Documentation: class TimestampSecondValue in module duckdb.value.constant class TimestampSecondValue(Value) | TimestampSecondValue(object: Any) -> None | | Method resolution order: | TimestampSecondValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.TimestampTimeZoneValue
Python Library Documentation: class TimestampTimeZoneValue in module duckdb.value.constant class TimestampTimeZoneValue(Value) | TimestampTimeZoneValue(object: Any) -> None | | Method resolution order: | TimestampTimeZoneValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.TimestampValue
Python Library Documentation: class TimestampValue in module duckdb.value.constant class TimestampValue(Value) | TimestampValue(object: Any) -> None | | Method resolution order: | TimestampValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.TransactionException
Python Library Documentation: class TransactionException in module _duckdb
class TransactionException(OperationalError)
| Method resolution order:
| TransactionException
| OperationalError
| DatabaseError
| Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
duckdb.TypeMismatchException
Python Library Documentation: class TypeMismatchException in module _duckdb
class TypeMismatchException(DataError)
| Method resolution order:
| TypeMismatchException
| DataError
| DatabaseError
| Error
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Error:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
duckdb.UUIDValue
Python Library Documentation: class UUIDValue in module duckdb.value.constant class UUIDValue(Value) | UUIDValue(object: Any) -> None | | Method resolution order: | UUIDValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.UnionType
Python Library Documentation: class UnionType in module duckdb.value.constant class UnionType(Value) | UnionType(object: Any, members: dict[str, _duckdb._sqltypes.DuckDBPyType]) -> None | | Method resolution order: | UnionType | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any, members: dict[str, _duckdb._sqltypes.DuckDBPyType]) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.UnsignedBinaryValue
Python Library Documentation: class UnsignedBinaryValue in module duckdb.value.constant class UnsignedBinaryValue(Value) | UnsignedBinaryValue(object: Any) -> None | | Method resolution order: | UnsignedBinaryValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.UnsignedHugeIntegerValue
Python Library Documentation: class UnsignedHugeIntegerValue in module duckdb.value.constant class UnsignedHugeIntegerValue(Value) | UnsignedHugeIntegerValue(object: Any) -> None | | Method resolution order: | UnsignedHugeIntegerValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.UnsignedIntegerValue
Python Library Documentation: class UnsignedIntegerValue in module duckdb.value.constant class UnsignedIntegerValue(Value) | UnsignedIntegerValue(object: Any) -> None | | Method resolution order: | UnsignedIntegerValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.UnsignedLongValue
Python Library Documentation: class UnsignedLongValue in module duckdb.value.constant class UnsignedLongValue(Value) | UnsignedLongValue(object: Any) -> None | | Method resolution order: | UnsignedLongValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.UnsignedShortValue
Python Library Documentation: class UnsignedShortValue in module duckdb.value.constant class UnsignedShortValue(Value) | UnsignedShortValue(object: Any) -> None | | Method resolution order: | UnsignedShortValue | Value | builtins.object | | Methods defined here: | | __init__(self, object: Any) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from Value: | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from Value: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.Value
Python Library Documentation: class Value in module duckdb.value.constant class Value(builtins.object) | Value(object: Any, type: _duckdb._sqltypes.DuckDBPyType) -> None | | Methods defined here: | | __init__(self, object: Any, type: _duckdb._sqltypes.DuckDBPyType) -> None | Initialize self. See help(type(self)) for accurate signature. | | __repr__(self) -> str | Return repr(self). | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
duckdb.Warning
Python Library Documentation: class Warning in module _duckdb class Warning(builtins.Exception) | Method resolution order: | Warning | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors defined here: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) class method of builtins.Exception | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args
duckdb.aggregate
Python Library Documentation: built-in function aggregate in module _duckdb
aggregate(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
aggregate(df: pandas.DataFrame, aggr_expr: object, group_expr: str = '', *, connection: duckdb.DuckDBPyConnection = None) -> _duckdb.DuckDBPyRelation
Compute the aggregate aggr_expr by the optional groups group_expr on the relation
duckdb.alias
Python Library Documentation: built-in function alias in module _duckdb
alias(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
alias(df: pandas.DataFrame, alias: str, *, connection: duckdb.DuckDBPyConnection = None) -> _duckdb.DuckDBPyRelation
Rename the relation object to new alias
duckdb.apilevel
Error rendering doc: No Python documentation found for '2.0'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
duckdb.append
Python Library Documentation: built-in function append in module _duckdb
append(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
append(table_name: str, df: pandas.DataFrame, *, by_name: bool = False, connection: duckdb.DuckDBPyConnection = None) -> duckdb.DuckDBPyConnection
Append the passed DataFrame to the named table
duckdb.array_type
Python Library Documentation: built-in function array_type in module _duckdb
array_type(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
array_type(type: _duckdb._sqltypes.DuckDBPyType, size: typing.SupportsInt | typing.SupportsIndex, *, connection: duckdb.DuckDBPyConnection = None) -> _duckdb._sqltypes.DuckDBPyType
Create an array type object of 'type'
duckdb.arrow
Python Library Documentation: built-in function arrow in module _duckdb
arrow(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
arrow(*args, **kwargs)
Overloaded function.
1. arrow(rows_per_batch: typing.SupportsInt | typing.SupportsIndex = 1000000, *, connection: duckdb.DuckDBPyConnection = None) -> pyarrow.lib.RecordBatchReader
Alias of to_arrow_reader(). We recommend using to_arrow_reader() instead.
2. arrow(arrow_object: object, *, connection: duckdb.DuckDBPyConnection = None) -> _duckdb.DuckDBPyRelation
Create a relation object from an Arrow object
duckdb.begin
Python Library Documentation: built-in function begin in module _duckdb
begin(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
begin(*, connection: duckdb.DuckDBPyConnection = None) -> duckdb.DuckDBPyConnection
Start a new transaction
duckdb.checkpoint
Python Library Documentation: built-in function checkpoint in module _duckdb
checkpoint(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
checkpoint(*, connection: duckdb.DuckDBPyConnection = None) -> duckdb.DuckDBPyConnection
Synchronizes data in the write-ahead log (WAL) to the database data file (no-op for in-memory connections)
duckdb.close
Python Library Documentation: built-in function close in module _duckdb
close(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
close(*, connection: duckdb.DuckDBPyConnection = None) -> None
Close the connection
duckdb.commit
Python Library Documentation: built-in function commit in module _duckdb
commit(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
commit(*, connection: duckdb.DuckDBPyConnection = None) -> duckdb.DuckDBPyConnection
Commit changes performed within a transaction
duckdb.connect
Python Library Documentation: built-in function connect in module _duckdb
connect(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
connect(database: object = ':memory:', read_only: bool = False, config: dict = None) -> duckdb.DuckDBPyConnection
Create a DuckDB database instance. Can take a database file name to read/write persistent data and a read_only flag if no changes are desired
duckdb.create_function
Python Library Documentation: built-in function create_function in module _duckdb
create_function(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
create_function(name: str, function: collections.abc.Callable, parameters: object = None, return_type: _duckdb._sqltypes.DuckDBPyType = None, *, type: _duckdb._func.PythonUDFType = <PythonUDFType.NATIVE: 0>, null_handling: _duckdb._func.FunctionNullHandling = <FunctionNullHandling.DEFAULT: 0>, exception_handling: _duckdb.PythonExceptionHandling = <PythonExceptionHandling.DEFAULT: 0>, side_effects: bool = False, connection: duckdb.DuckDBPyConnection = None) -> duckdb.DuckDBPyConnection
Create a DuckDB function out of the passing in Python function so it can be used in queries
duckdb.cursor
Python Library Documentation: built-in function cursor in module _duckdb
cursor(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
cursor(*, connection: duckdb.DuckDBPyConnection = None) -> duckdb.DuckDBPyConnection
Create a duplicate of the current connection
duckdb.decimal_type
Python Library Documentation: built-in function decimal_type in module _duckdb
decimal_type(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
decimal_type(width: typing.SupportsInt | typing.SupportsIndex, scale: typing.SupportsInt | typing.SupportsIndex, *, connection: duckdb.DuckDBPyConnection = None) -> _duckdb._sqltypes.DuckDBPyType
Create a decimal type with 'width' and 'scale'
duckdb.default_connection
Python Library Documentation: built-in function default_connection in module _duckdb
default_connection(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
default_connection() -> duckdb.DuckDBPyConnection
Retrieve the connection currently registered as the default to be used by the module
duckdb.description
Python Library Documentation: built-in function description in module _duckdb
description(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
description(*, connection: duckdb.DuckDBPyConnection = None) -> typing.Optional[list]
Get result set attributes, mainly column names
duckdb.df
Python Library Documentation: built-in function df in module _duckdb
df(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
df(*args, **kwargs)
Overloaded function.
1. df(*, date_as_object: bool = False, connection: duckdb.DuckDBPyConnection = None) -> pandas.DataFrame
Fetch a result as DataFrame following execute()
2. df(*, date_as_object: bool = False, connection: duckdb.DuckDBPyConnection = None) -> pandas.DataFrame
Fetch a result as DataFrame following execute()
3. df(df: pandas.DataFrame, *, connection: duckdb.DuckDBPyConnection = None) -> _duckdb.DuckDBPyRelation
Create a relation object from the DataFrame df
duckdb.disable_profiling
Python Library Documentation: built-in function disable_profiling in module _duckdb
disable_profiling(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
disable_profiling(*, connection: duckdb.DuckDBPyConnection = None) -> None
Disable profiling for the current connection
duckdb.distinct
Python Library Documentation: built-in function distinct in module _duckdb
distinct(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
distinct(df: pandas.DataFrame, *, connection: duckdb.DuckDBPyConnection = None) -> _duckdb.DuckDBPyRelation
Retrieve distinct rows from this relation object
duckdb.dtype
Python Library Documentation: built-in function dtype in module _duckdb
dtype(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
dtype(type_str: str, *, connection: duckdb.DuckDBPyConnection = None) -> _duckdb._sqltypes.DuckDBPyType
Create a type object by parsing the 'type_str' string
duckdb.duplicate
Python Library Documentation: built-in function duplicate in module _duckdb
duplicate(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
duplicate(*, connection: duckdb.DuckDBPyConnection = None) -> duckdb.DuckDBPyConnection
Create a duplicate of the current connection
duckdb.enable_profiling
Python Library Documentation: built-in function enable_profiling in module _duckdb
enable_profiling(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
enable_profiling(*, connection: duckdb.DuckDBPyConnection = None) -> None
Enable profiling for the current connection
duckdb.enum_type
Python Library Documentation: built-in function enum_type in module _duckdb
enum_type(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
enum_type(name: str, type: _duckdb._sqltypes.DuckDBPyType, values: list, *, connection: duckdb.DuckDBPyConnection = None) -> _duckdb._sqltypes.DuckDBPyType
Create an enum type of underlying 'type', consisting of the list of 'values'
duckdb.execute
Python Library Documentation: built-in function execute in module _duckdb
execute(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
execute(query: object, parameters: object = None, *, connection: duckdb.DuckDBPyConnection = None) -> duckdb.DuckDBPyConnection
Execute the given SQL query, optionally using prepared statements with parameters set
duckdb.executemany
Python Library Documentation: built-in function executemany in module _duckdb
executemany(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
executemany(query: object, parameters: object = None, *, connection: duckdb.DuckDBPyConnection = None) -> duckdb.DuckDBPyConnection
Execute the given prepared statement multiple times using the list of parameter sets in parameters
duckdb.extract_statements
Python Library Documentation: built-in function extract_statements in module _duckdb
extract_statements(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
extract_statements(query: str, *, connection: duckdb.DuckDBPyConnection = None) -> list
Parse the query string and extract the Statement object(s) produced
duckdb.fetch_arrow_table
Python Library Documentation: built-in function fetch_arrow_table in module _duckdb
fetch_arrow_table(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
fetch_arrow_table(rows_per_batch: typing.SupportsInt | typing.SupportsIndex = 1000000, *, connection: duckdb.DuckDBPyConnection = None) -> pyarrow.lib.Table
Fetch a result as Arrow table following execute()
duckdb.fetch_df
Python Library Documentation: built-in function fetch_df in module _duckdb
fetch_df(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
fetch_df(*, date_as_object: bool = False, connection: duckdb.DuckDBPyConnection = None) -> pandas.DataFrame
Fetch a result as DataFrame following execute()
duckdb.fetch_df_chunk
Python Library Documentation: built-in function fetch_df_chunk in module _duckdb
fetch_df_chunk(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
fetch_df_chunk(vectors_per_chunk: typing.SupportsInt | typing.SupportsIndex = 1, *, date_as_object: bool = False, connection: duckdb.DuckDBPyConnection = None) -> pandas.DataFrame
Fetch a chunk of the result as DataFrame following execute()
duckdb.fetch_record_batch
Python Library Documentation: built-in function fetch_record_batch in module _duckdb
fetch_record_batch(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
fetch_record_batch(rows_per_batch: typing.SupportsInt | typing.SupportsIndex = 1000000, *, connection: duckdb.DuckDBPyConnection = None) -> pyarrow.lib.RecordBatchReader
Fetch an Arrow RecordBatchReader following execute()
duckdb.fetchall
Python Library Documentation: built-in function fetchall in module _duckdb
fetchall(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
fetchall(*, connection: duckdb.DuckDBPyConnection = None) -> list
Fetch all rows from a result following execute
duckdb.fetchdf
Python Library Documentation: built-in function fetchdf in module _duckdb
fetchdf(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
fetchdf(*, date_as_object: bool = False, connection: duckdb.DuckDBPyConnection = None) -> pandas.DataFrame
Fetch a result as DataFrame following execute()
duckdb.fetchmany
Python Library Documentation: built-in function fetchmany in module _duckdb
fetchmany(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
fetchmany(size: typing.SupportsInt | typing.SupportsIndex = 1, *, connection: duckdb.DuckDBPyConnection = None) -> list
Fetch the next set of rows from a result following execute
duckdb.fetchnumpy
Python Library Documentation: built-in function fetchnumpy in module _duckdb
fetchnumpy(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
fetchnumpy(*, connection: duckdb.DuckDBPyConnection = None) -> dict
Fetch a result as list of NumPy arrays following execute
duckdb.fetchone
Python Library Documentation: built-in function fetchone in module _duckdb
fetchone(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
fetchone(*, connection: duckdb.DuckDBPyConnection = None) -> typing.Optional[tuple]
Fetch a single row from a result following execute
duckdb.filesystem_is_registered
Python Library Documentation: built-in function filesystem_is_registered in module _duckdb
filesystem_is_registered(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
filesystem_is_registered(name: str, *, connection: duckdb.DuckDBPyConnection = None) -> bool
Check if a filesystem with the provided name is currently registered
duckdb.filter
Python Library Documentation: built-in function filter in module _duckdb
filter(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
filter(df: pandas.DataFrame, filter_expr: object, *, connection: duckdb.DuckDBPyConnection = None) -> _duckdb.DuckDBPyRelation
Filter the relation object by the filter in filter_expr
duckdb.from_arrow
Python Library Documentation: built-in function from_arrow in module _duckdb
from_arrow(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
from_arrow(arrow_object: object, *, connection: duckdb.DuckDBPyConnection = None) -> _duckdb.DuckDBPyRelation
Create a relation object from an Arrow object
duckdb.from_csv_auto
Python Library Documentation: built-in function from_csv_auto in module _duckdb
from_csv_auto(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
from_csv_auto(path_or_buffer: object, **kwargs) -> _duckdb.DuckDBPyRelation
Create a relation object from the CSV file in 'name'
duckdb.from_df
Python Library Documentation: built-in function from_df in module _duckdb
from_df(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
from_df(df: pandas.DataFrame, *, connection: duckdb.DuckDBPyConnection = None) -> _duckdb.DuckDBPyRelation
Create a relation object from the DataFrame in df
duckdb.from_parquet
Python Library Documentation: built-in function from_parquet in module _duckdb
from_parquet(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
from_parquet(path_or_buffer: object, binary_as_string: bool = False, *, file_row_number: bool = False, filename: bool = False, hive_partitioning: bool = False, union_by_name: bool = False, compression: object = None, connection: duckdb.DuckDBPyConnection = None) -> _duckdb.DuckDBPyRelation
Create a relation object from the Parquet path(s) or file-like object(s) in 'path_or_buffer'
duckdb.from_query
Python Library Documentation: built-in function from_query in module _duckdb
from_query(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
from_query(query: object, *, alias: str = '', params: object = None, connection: duckdb.DuckDBPyConnection = None) -> _duckdb.DuckDBPyRelation
Run a SQL query. If it is a SELECT statement, create a relation object from the given SQL query, otherwise run the query as-is.
duckdb.get_profiling_information
Python Library Documentation: built-in function get_profiling_information in module _duckdb
get_profiling_information(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
get_profiling_information(*, format: str = 'json', connection: duckdb.DuckDBPyConnection = None) -> str
Get profiling information from a query
duckdb.get_table_names
Python Library Documentation: built-in function get_table_names in module _duckdb
get_table_names(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
get_table_names(query: str, *, qualified: bool = False, connection: duckdb.DuckDBPyConnection = None) -> set[str]
Extract the required table names from a query
duckdb.install_extension
Python Library Documentation: built-in function install_extension in module _duckdb
install_extension(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
install_extension(extension: str, *, force_install: bool = False, repository: object = None, repository_url: object = None, version: object = None, connection: duckdb.DuckDBPyConnection = None) -> None
Install an extension by name, with an optional version and/or repository to get the extension from
duckdb.interrupt
Python Library Documentation: built-in function interrupt in module _duckdb
interrupt(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
interrupt(*, connection: duckdb.DuckDBPyConnection = None) -> None
Interrupt pending operations
duckdb.limit
Python Library Documentation: built-in function limit in module _duckdb
limit(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
limit(df: pandas.DataFrame, n: typing.SupportsInt | typing.SupportsIndex, offset: typing.SupportsInt | typing.SupportsIndex = 0, *, connection: duckdb.DuckDBPyConnection = None) -> _duckdb.DuckDBPyRelation
Only retrieve the first n rows from this relation object, starting at offset
duckdb.list_filesystems
Python Library Documentation: built-in function list_filesystems in module _duckdb
list_filesystems(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
list_filesystems(*, connection: duckdb.DuckDBPyConnection = None) -> list
List registered filesystems, including builtin ones
duckdb.list_type
Python Library Documentation: built-in function list_type in module _duckdb
list_type(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
list_type(type: _duckdb._sqltypes.DuckDBPyType, *, connection: duckdb.DuckDBPyConnection = None) -> _duckdb._sqltypes.DuckDBPyType
Create a list type object of 'type'
duckdb.load_extension
Python Library Documentation: built-in function load_extension in module _duckdb
load_extension(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
load_extension(extension: str, *, connection: duckdb.DuckDBPyConnection = None) -> None
Load an installed extension
duckdb.map_type
Python Library Documentation: built-in function map_type in module _duckdb
map_type(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
map_type(key: _duckdb._sqltypes.DuckDBPyType, value: _duckdb._sqltypes.DuckDBPyType, *, connection: duckdb.DuckDBPyConnection = None) -> _duckdb._sqltypes.DuckDBPyType
Create a map type object from 'key_type' and 'value_type'
duckdb.order
Python Library Documentation: built-in function order in module _duckdb
order(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
order(df: pandas.DataFrame, order_expr: str, *, connection: duckdb.DuckDBPyConnection = None) -> _duckdb.DuckDBPyRelation
Reorder the relation object by order_expr
duckdb.paramstyle
Error rendering doc: No Python documentation found for 'qmark'. Use help() to get the interactive help utility. Use help(str) for help on the str class.
duckdb.pl
Python Library Documentation: built-in function pl in module _duckdb
pl(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
pl(rows_per_batch: typing.SupportsInt | typing.SupportsIndex = 1000000, *, lazy: bool = False, connection: duckdb.DuckDBPyConnection = None) -> duckdb::PolarsDataFrame
Fetch a result as Polars DataFrame following execute()
duckdb.project
Python Library Documentation: built-in function project in module _duckdb
project(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
project(df: pandas.DataFrame, *args, groups: str = '', connection: duckdb.DuckDBPyConnection = None) -> _duckdb.DuckDBPyRelation
Project the relation object by the projection in project_expr
duckdb.query
Python Library Documentation: built-in function query in module _duckdb
query(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
query(query: object, *, alias: str = '', params: object = None, connection: duckdb.DuckDBPyConnection = None) -> _duckdb.DuckDBPyRelation
Run a SQL query. If it is a SELECT statement, create a relation object from the given SQL query, otherwise run the query as-is.
duckdb.query_df
Python Library Documentation: built-in function query_df in module _duckdb
query_df(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
query_df(df: pandas.DataFrame, virtual_table_name: str, sql_query: str, *, connection: duckdb.DuckDBPyConnection = None) -> _duckdb.DuckDBPyRelation
Run the given SQL query in sql_query on the view named virtual_table_name that refers to the relation object
duckdb.query_progress
Python Library Documentation: built-in function query_progress in module _duckdb
query_progress(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
query_progress(*, connection: duckdb.DuckDBPyConnection = None) -> float
Query progress of pending operation
duckdb.read_csv
Python Library Documentation: built-in function read_csv in module _duckdb
read_csv(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
read_csv(path_or_buffer: object, **kwargs) -> _duckdb.DuckDBPyRelation
Create a relation object from the CSV file in 'name'
duckdb.read_json
Python Library Documentation: built-in function read_json in module _duckdb
read_json(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
read_json(path_or_buffer: object, *, columns: typing.Optional[object] = None, sample_size: typing.Optional[object] = None, maximum_depth: typing.Optional[object] = None, records: typing.Optional[str] = None, format: typing.Optional[str] = None, date_format: typing.Optional[object] = None, timestamp_format: typing.Optional[object] = None, compression: typing.Optional[object] = None, maximum_object_size: typing.Optional[object] = None, ignore_errors: typing.Optional[object] = None, convert_strings_to_integers: typing.Optional[object] = None, field_appearance_threshold: typing.Optional[object] = None, map_inference_threshold: typing.Optional[object] = None, maximum_sample_files: typing.Optional[object] = None, filename: typing.Optional[object] = None, hive_partitioning: typing.Optional[object] = None, union_by_name: typing.Optional[object] = None, hive_types: typing.Optional[object] = None, hive_types_autocast: typing.Optional[object] = None, connection: duckdb.DuckDBPyConnection = None) -> _duckdb.DuckDBPyRelation
Create a relation object from the JSON file in 'name'
duckdb.read_parquet
Python Library Documentation: built-in function read_parquet in module _duckdb
read_parquet(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
read_parquet(path_or_buffer: object, binary_as_string: bool = False, *, file_row_number: bool = False, filename: bool = False, hive_partitioning: bool = False, union_by_name: bool = False, compression: object = None, connection: duckdb.DuckDBPyConnection = None) -> _duckdb.DuckDBPyRelation
Create a relation object from the Parquet path(s) or file-like object(s) in 'path_or_buffer'
duckdb.register
Python Library Documentation: built-in function register in module _duckdb
register(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
register(view_name: str, python_object: object, *, connection: duckdb.DuckDBPyConnection = None) -> duckdb.DuckDBPyConnection
Register the passed Python Object value for querying with a view
duckdb.register_filesystem
Python Library Documentation: built-in function register_filesystem in module _duckdb
register_filesystem(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
register_filesystem(filesystem: fsspec.AbstractFileSystem, *, connection: duckdb.DuckDBPyConnection = None) -> None
Register a fsspec compliant filesystem
duckdb.remove_function
Python Library Documentation: built-in function remove_function in module _duckdb
remove_function(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
remove_function(name: str, *, connection: duckdb.DuckDBPyConnection = None) -> duckdb.DuckDBPyConnection
Remove a previously created function
duckdb.rollback
Python Library Documentation: built-in function rollback in module _duckdb
rollback(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
rollback(*, connection: duckdb.DuckDBPyConnection = None) -> duckdb.DuckDBPyConnection
Roll back changes performed within a transaction
duckdb.row_type
Python Library Documentation: built-in function row_type in module _duckdb
row_type(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
row_type(fields: object, *, connection: duckdb.DuckDBPyConnection = None) -> _duckdb._sqltypes.DuckDBPyType
Create a struct type object from 'fields'
duckdb.rowcount
Python Library Documentation: built-in function rowcount in module _duckdb
rowcount(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
rowcount(*, connection: duckdb.DuckDBPyConnection = None) -> int
Get result set row count
duckdb.set_default_connection
Python Library Documentation: built-in function set_default_connection in module _duckdb
set_default_connection(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
set_default_connection(connection: duckdb.DuckDBPyConnection) -> None
Register the provided connection as the default to be used by the module
duckdb.sql
Python Library Documentation: built-in function sql in module _duckdb
sql(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
sql(query: object, *, alias: str = '', params: object = None, connection: duckdb.DuckDBPyConnection = None) -> _duckdb.DuckDBPyRelation
Run a SQL query. If it is a SELECT statement, create a relation object from the given SQL query, otherwise run the query as-is.
duckdb.sqltype
Python Library Documentation: built-in function sqltype in module _duckdb
sqltype(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
sqltype(type_str: str, *, connection: duckdb.DuckDBPyConnection = None) -> _duckdb._sqltypes.DuckDBPyType
Create a type object by parsing the 'type_str' string
duckdb.sqltypes
Python Library Documentation: package duckdb.sqltypes in duckdb
NAME
duckdb.sqltypes - DuckDB's SQL types.
PACKAGE CONTENTS
CLASSES
pybind11_builtins.pybind11_object(builtins.object)
_duckdb._sqltypes.DuckDBPyType
class DuckDBPyType(pybind11_builtins.pybind11_object)
| Method resolution order:
| DuckDBPyType
| pybind11_builtins.pybind11_object
| builtins.object
|
| Methods defined here:
|
| __eq__(...)
| __eq__(*args, **kwargs)
| Overloaded function.
|
| 1. __eq__(self: _duckdb._sqltypes.DuckDBPyType, other: _duckdb._sqltypes.DuckDBPyType) -> bool
|
| Compare two types for equality
|
| 2. __eq__(self: _duckdb._sqltypes.DuckDBPyType, other: str) -> bool
|
| Compare two types for equality
|
| __getattr__(...)
| __getattr__(self: _duckdb._sqltypes.DuckDBPyType, name: str) -> _duckdb._sqltypes.DuckDBPyType
|
| Get the child type by 'name'
|
| __getitem__(...)
| __getitem__(self: _duckdb._sqltypes.DuckDBPyType, name: str) -> _duckdb._sqltypes.DuckDBPyType
|
| Get the child type by 'name'
|
| __hash__(...)
| __hash__(self: _duckdb._sqltypes.DuckDBPyType) -> int
|
| __init__(...)
| __init__(*args, **kwargs)
| Overloaded function.
|
| 1. __init__(self: _duckdb._sqltypes.DuckDBPyType, arg0: str, arg1: duckdb::DuckDBPyConnection) -> None
|
| 2. __init__(self: _duckdb._sqltypes.DuckDBPyType, arg0: duckdb::PyGenericAlias) -> None
|
| 3. __init__(self: _duckdb._sqltypes.DuckDBPyType, arg0: duckdb::PyUnionType) -> None
|
| 4. __init__(self: _duckdb._sqltypes.DuckDBPyType, arg0: object) -> None
|
| __repr__(...)
| __repr__(self: _duckdb._sqltypes.DuckDBPyType) -> str
|
| Stringified representation of the type object
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| children
|
| id
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __pybind11_module_local_v11_msvc_mt_mscver1944__ = <capsule object NUL...
|
| ----------------------------------------------------------------------
| Static methods inherited from pybind11_builtins.pybind11_object:
|
| __new__(*args, **kwargs) class method of pybind11_builtins.pybind11_object
| Create and return a new object. See help(type) for accurate signature.
DATA
BIGINT = BIGINT
BIT = BIT
BLOB = BLOB
BOOLEAN = BOOLEAN
DATE = DATE
DOUBLE = DOUBLE
FLOAT = FLOAT
HUGEINT = HUGEINT
INTEGER = INTEGER
INTERVAL = INTERVAL
SMALLINT = SMALLINT
SQLNULL = "NULL"
TIME = TIME
TIMESTAMP = TIMESTAMP
TIMESTAMP_MS = TIMESTAMP_MS
TIMESTAMP_NS = TIMESTAMP_NS
TIMESTAMP_S = TIMESTAMP_S
TIMESTAMP_TZ = TIMESTAMP WITH TIME ZONE
TIME_NS = TIME_NS
TIME_TZ = TIME WITH TIME ZONE
TINYINT = TINYINT
UBIGINT = UBIGINT
UHUGEINT = UHUGEINT
UINTEGER = UINTEGER
USMALLINT = USMALLINT
UTINYINT = UTINYINT
UUID = UUID
VARCHAR = VARCHAR
VARIANT = VARIANT
__all__ = ['BIGINT', 'BIT', 'BLOB', 'BOOLEAN', 'DATE', 'DOUBLE', 'FLOA...
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\duckdb\sqltypes\__init__.py
duckdb.string_type
Python Library Documentation: built-in function string_type in module _duckdb
string_type(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
string_type(collation: str = '', *, connection: duckdb.DuckDBPyConnection = None) -> _duckdb._sqltypes.DuckDBPyType
Create a string type with an optional collation
duckdb.struct_type
Python Library Documentation: built-in function struct_type in module _duckdb
struct_type(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
struct_type(fields: object, *, connection: duckdb.DuckDBPyConnection = None) -> _duckdb._sqltypes.DuckDBPyType
Create a struct type object from 'fields'
duckdb.table
Python Library Documentation: built-in function table in module _duckdb
table(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
table(table_name: str, *, connection: duckdb.DuckDBPyConnection = None) -> _duckdb.DuckDBPyRelation
Create a relation object for the named table
duckdb.table_function
Python Library Documentation: built-in function table_function in module _duckdb
table_function(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
table_function(name: str, parameters: object = None, *, connection: duckdb.DuckDBPyConnection = None) -> _duckdb.DuckDBPyRelation
Create a relation object from the named table function with given parameters
duckdb.tf
Python Library Documentation: built-in function tf in module _duckdb
tf(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
tf(*, connection: duckdb.DuckDBPyConnection = None) -> dict
Fetch a result as dict of TensorFlow Tensors following execute()
duckdb.threadsafety
Python Library Documentation: int object
class int(object)
| int([x]) -> integer
| int(x, base=10) -> integer
|
| Convert a number or string to an integer, or return 0 if no arguments
| are given. If x is a number, return x.__int__(). For floating-point
| numbers, this truncates towards zero.
|
| If x is not a number or if base is given, then x must be a string,
| bytes, or bytearray instance representing an integer literal in the
| given base. The literal can be preceded by '+' or '-' and be surrounded
| by whitespace. The base defaults to 10. Valid bases are 0 and 2-36.
| Base 0 means to interpret the base from the string as an integer literal.
| >>> int('0b100', base=0)
| 4
|
| Built-in subclasses:
| bool
|
| Methods defined here:
|
| __abs__(self, /)
| abs(self)
|
| __add__(self, value, /)
| Return self+value.
|
| __and__(self, value, /)
| Return self&value.
|
| __bool__(self, /)
| True if self else False
|
| __ceil__(...)
| Ceiling of an Integral returns itself.
|
| __divmod__(self, value, /)
| Return divmod(self, value).
|
| __eq__(self, value, /)
| Return self==value.
|
| __float__(self, /)
| float(self)
|
| __floor__(...)
| Flooring an Integral returns itself.
|
| __floordiv__(self, value, /)
| Return self//value.
|
| __format__(self, format_spec, /)
| Convert to a string according to format_spec.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getnewargs__(self, /)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __index__(self, /)
| Return self converted to an integer, if self is suitable for use as an index into a list.
|
| __int__(self, /)
| int(self)
|
| __invert__(self, /)
| ~self
|
| __le__(self, value, /)
| Return self<=value.
|
| __lshift__(self, value, /)
| Return self<<value.
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __neg__(self, /)
| -self
|
| __or__(self, value, /)
| Return self|value.
|
| __pos__(self, /)
| +self
|
| __pow__(self, value, mod=None, /)
| Return pow(self, value, mod).
|
| __radd__(self, value, /)
| Return value+self.
|
| __rand__(self, value, /)
| Return value&self.
|
| __rdivmod__(self, value, /)
| Return divmod(value, self).
|
| __repr__(self, /)
| Return repr(self).
|
| __rfloordiv__(self, value, /)
| Return value//self.
|
| __rlshift__(self, value, /)
| Return value<<self.
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __ror__(self, value, /)
| Return value|self.
|
| __round__(...)
| Rounding an Integral returns itself.
|
| Rounding with an ndigits argument also returns an integer.
|
| __rpow__(self, value, mod=None, /)
| Return pow(value, self, mod).
|
| __rrshift__(self, value, /)
| Return value>>self.
|
| __rshift__(self, value, /)
| Return self>>value.
|
| __rsub__(self, value, /)
| Return value-self.
|
| __rtruediv__(self, value, /)
| Return value/self.
|
| __rxor__(self, value, /)
| Return value^self.
|
| __sizeof__(self, /)
| Returns size in memory, in bytes.
|
| __sub__(self, value, /)
| Return self-value.
|
| __truediv__(self, value, /)
| Return self/value.
|
| __trunc__(...)
| Truncating an Integral returns itself.
|
| __xor__(self, value, /)
| Return self^value.
|
| as_integer_ratio(self, /)
| Return a pair of integers, whose ratio is equal to the original int.
|
| The ratio is in lowest terms and has a positive denominator.
|
| >>> (10).as_integer_ratio()
| (10, 1)
| >>> (-10).as_integer_ratio()
| (-10, 1)
| >>> (0).as_integer_ratio()
| (0, 1)
|
| bit_count(self, /)
| Number of ones in the binary representation of the absolute value of self.
|
| Also known as the population count.
|
| >>> bin(13)
| '0b1101'
| >>> (13).bit_count()
| 3
|
| bit_length(self, /)
| Number of bits necessary to represent self in binary.
|
| >>> bin(37)
| '0b100101'
| >>> (37).bit_length()
| 6
|
| conjugate(...)
| Returns self, the complex conjugate of any int.
|
| is_integer(self, /)
| Returns True. Exists for duck type compatibility with float.is_integer.
|
| to_bytes(self, /, length=1, byteorder='big', *, signed=False)
| Return an array of bytes representing an integer.
|
| length
| Length of bytes object to use. An OverflowError is raised if the
| integer is not representable with the given number of bytes. Default
| is length 1.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Determines whether two's complement is used to represent the integer.
| If signed is False and a negative integer is given, an OverflowError
| is raised.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| from_bytes(bytes, byteorder='big', *, signed=False)
| Return the integer represented by the given array of bytes.
|
| bytes
| Holds the array of bytes to convert. The argument must either
| support the buffer protocol or be an iterable object producing bytes.
| Bytes and bytearray are examples of built-in objects that support the
| buffer protocol.
| byteorder
| The byte order used to represent the integer. If byteorder is 'big',
| the most significant byte is at the beginning of the byte array. If
| byteorder is 'little', the most significant byte is at the end of the
| byte array. To request the native byte order of the host system, use
| `sys.byteorder' as the byte order value. Default is to use 'big'.
| signed
| Indicates whether two's complement is used to represent the integer.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(*args, **kwargs)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| denominator
| the denominator of a rational number in lowest terms
|
| imag
| the imaginary part of a complex number
|
| numerator
| the numerator of a rational number in lowest terms
|
| real
| the real part of a complex number
duckdb.to_arrow_reader
Python Library Documentation: built-in function to_arrow_reader in module _duckdb
to_arrow_reader(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
to_arrow_reader(batch_size: typing.SupportsInt | typing.SupportsIndex = 1000000, *, connection: duckdb.DuckDBPyConnection = None) -> pyarrow.lib.RecordBatchReader
Fetch an Arrow RecordBatchReader following execute()
duckdb.to_arrow_table
Python Library Documentation: built-in function to_arrow_table in module _duckdb
to_arrow_table(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
to_arrow_table(batch_size: typing.SupportsInt | typing.SupportsIndex = 1000000, *, connection: duckdb.DuckDBPyConnection = None) -> pyarrow.lib.Table
Fetch a result as Arrow table following execute()
duckdb.token_type
Python Library Documentation: class token_type in module _duckdb class token_type(pybind11_builtins.pybind11_object) | Method resolution order: | token_type | pybind11_builtins.pybind11_object | builtins.object | | Methods defined here: | | __eq__(...) | __eq__(self: object, other: object, /) -> bool | | __getstate__(...) | __getstate__(self: object, /) -> int | | __hash__(...) | __hash__(self: object, /) -> int | | __index__(...) | __index__(self: _duckdb.token_type, /) -> int | | __init__(...) | __init__(self: _duckdb.token_type, value: typing.SupportsInt | typing.SupportsIndex) -> None | | __int__(...) | __int__(self: _duckdb.token_type, /) -> int | | __ne__(...) | __ne__(self: object, other: object, /) -> bool | | __repr__(...) | __repr__(self: object, /) -> str | | __setstate__(...) | __setstate__(self: _duckdb.token_type, state: typing.SupportsInt | typing.SupportsIndex, /) -> None | | __str__(...) | __str__(self: object, /) -> str | | ---------------------------------------------------------------------- | Readonly properties defined here: | | __members__ | | name | name(self: object, /) -> str | | value | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __pybind11_module_local_v11_msvc_mt_mscver1944__ = <capsule object NUL... | | comment = <token_type.comment: 5> | | identifier = <token_type.identifier: 0> | | keyword = <token_type.keyword: 4> | | numeric_const = <token_type.numeric_const: 1> | | operator = <token_type.operator: 3> | | string_const = <token_type.string_const: 2> | | ---------------------------------------------------------------------- | Static methods inherited from pybind11_builtins.pybind11_object: | | __new__(*args, **kwargs) class method of pybind11_builtins.pybind11_object | Create and return a new object. See help(type) for accurate signature.
duckdb.tokenize
Python Library Documentation: built-in function tokenize in module _duckdb
tokenize(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
tokenize(query: str) -> list
Tokenizes a SQL string, returning a list of (position, type) tuples that can be used for e.g., syntax highlighting
duckdb.torch
Python Library Documentation: built-in function torch in module _duckdb
torch(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
torch(*, connection: duckdb.DuckDBPyConnection = None) -> dict
Fetch a result as dict of PyTorch Tensors following execute()
duckdb.type
Python Library Documentation: built-in function type in module _duckdb
type(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
type(type_str: str, *, connection: duckdb.DuckDBPyConnection = None) -> _duckdb._sqltypes.DuckDBPyType
Create a type object by parsing the 'type_str' string
duckdb.union_type
Python Library Documentation: built-in function union_type in module _duckdb
union_type(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
union_type(members: object, *, connection: duckdb.DuckDBPyConnection = None) -> _duckdb._sqltypes.DuckDBPyType
Create a union type object from 'members'
duckdb.unregister
Python Library Documentation: built-in function unregister in module _duckdb
unregister(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
unregister(view_name: str, *, connection: duckdb.DuckDBPyConnection = None) -> duckdb.DuckDBPyConnection
Unregister the view name
duckdb.unregister_filesystem
Python Library Documentation: built-in function unregister_filesystem in module _duckdb
unregister_filesystem(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
unregister_filesystem(name: str, *, connection: duckdb.DuckDBPyConnection = None) -> None
Unregister a filesystem
duckdb.value
Python Library Documentation: package duckdb.value in duckdb
NAME
duckdb.value - # noqa: D104
PACKAGE CONTENTS
constant (package)
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\duckdb\value\__init__.py
duckdb.values
Python Library Documentation: built-in function values in module _duckdb
values(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
values(*args, connection: duckdb.DuckDBPyConnection = None) -> _duckdb.DuckDBPyRelation
Create a relation object from the passed values
duckdb.version
Python Library Documentation: function version in module duckdb._version
version() -> str
Human-friendly formatted version string of both the distribution package and the bundled DuckDB engine.
duckdb.view
Python Library Documentation: built-in function view in module _duckdb
view(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
view(view_name: str, *, connection: duckdb.DuckDBPyConnection = None) -> _duckdb.DuckDBPyRelation
Create a relation object for the named view
duckdb.write_csv
Python Library Documentation: built-in function write_csv in module _duckdb
write_csv(...) method of pybind11_builtins.pybind11_detail_function_record_v1_msvc_mt_mscver1944 instance
write_csv(df: pandas.DataFrame, filename: str, *, sep: object = None, na_rep: object = None, header: object = None, quotechar: object = None, escapechar: object = None, date_format: object = None, timestamp_format: object = None, quoting: object = None, encoding: object = None, compression: object = None, overwrite: object = None, per_thread_output: object = None, use_tmp_file: object = None, partition_by: object = None, write_partition_columns: object = None, connection: duckdb.DuckDBPyConnection = None) -> None
Write the relation object to a CSV file in 'file_name'