Struct DataCatalogConfig 

pub struct DataCatalogConfig { /* private fields */ }

Configuration for a catalog available to request-time historical data loading.

Implementations

impl DataCatalogConfig

pub fn builder() -> DataCatalogConfigBuilder

Create an instance of DataCatalogConfig using the builder syntax

impl DataCatalogConfig

pub fn new( path: String, fs_protocol: Option<String>, catalog_backend: Option<CatalogBackendType>, ) -> Self

Creates a new DataCatalogConfig instance.

pub fn with_storage_options( self, options: Option<AHashMap<String, String>>, ) -> Self

Sets native object-store connection options.

pub fn fs_rust_storage_options(&self) -> Option<&AHashMap<String, String>>

Returns native object-store options.

pub fn create_catalog(&self) -> Result<DataCatalog>

Creates the configured catalog through the built-in factory registry.

Errors

Returns an error if the backend is unavailable or its connection cannot be opened.

pub fn with_name(self, name: Option<String>) -> Self

Returns a copy with catalog registration name set.

pub fn with_params(self, params: Option<Params>) -> Self

Returns a copy with backend-specific catalog parameters set.

pub const fn with_read_only(self, read_only: bool) -> Self

Returns a copy with read-only response write-back behavior set.

pub fn path(&self) -> &str

Returns the path to the data catalog.

pub fn name(&self) -> Option<&str>

Returns the catalog registration name.

pub const fn read_only(&self) -> bool

Returns whether the catalog rejects response write-back.

pub fn fs_protocol(&self) -> &str

Returns the fsspec file system protocol for the data catalog.

pub const fn catalog_backend(&self) -> &CatalogBackendType

Returns the catalog backend implementation to use.

pub const fn params(&self) -> Option<&Params>

Returns backend-specific catalog parameters.

Trait Implementations

impl Clone for DataCatalogConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DataCatalogConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DerefToPyAny for DataCatalogConfig

impl<'de> Deserialize<'de> for DataCatalogConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a, 'py> FromPyObject<'a, 'py> for DataCatalogConfig

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for DataCatalogConfig

type Target = DataCatalogConfig

The Python output type

type Output = Bound<'py, <DataCatalogConfig as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PartialEq for DataCatalogConfig

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PyClass for DataCatalogConfig

const NAME: &str = "DataCatalogConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for DataCatalogConfig

const MODULE: Option<&str>

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Configuration for a catalog available to request-time historical data loading.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<DataCatalogConfig as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<DataCatalogConfig>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForDataCatalogConfig

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for DataCatalogConfig

const TEXT_SIGNATURE: &'static str = "(path, fs_protocol=None, catalog_backend=None, params=None, name=None, read_only=False, fs_rust_storage_options=None)"

impl PyStubType for DataCatalogConfig

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for DataCatalogConfig

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Serialize for DataCatalogConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DataCatalogConfig