pyreindexer.rx_connector

RxConnector Objects

classRxConnector(RaiserMixin)

Arguments:

    dsn (string): The connection string which contains a protocol        Examples: 'builtin:///tmp/pyrx', 'cproto://127.0.0.1:6534/pyrx'    cproto options:         fetch_amount (int): The number of items that will be fetched by one operation         reconnect_attempts (int): Number of reconnection attempts when connection is lost         net_timeout (`datetime.timedelta`): Connection and database login timeout value [milliseconds]         enable_compression (bool): Flag enable/disable traffic compression         start_special_thread (bool): Determines whether to request a special thread of execution            on the server for this connection         client_name (string): Proper name of the application (as a client for Reindexer-server)         sync_rxcoro_count (int): Client concurrency per connection [1..10'000], default 10    built-in options:        max_replication_updates_size (int): Max pended replication updates size in bytes        allocator_cache_limit (int): Recommended maximum free cache size of tcmalloc memory allocator in bytes        allocator_cache_part (float): Recommended maximum free cache size of tcmalloc memory allocator in            relation to total Reindexer allocated memory size, in units

Attributes:

api (module): An API module loaded dynamically for Reindexer callsrx (int): A memory pointer to the Reindexer instanceerr_code (int): The API error codeerr_msg (string): The API error message

RxConnector.close

defclose()->None

Raises:

ConnectionError: Raises with an error message when Reindexer instance is not initialized yet

RxConnector.namespace_open

defnamespace_open(namespace:str,timeout:timedelta=timedelta(milliseconds=0))->None

Arguments:

namespace (string): The name of the namespacetimeout (`datetime.timedelta`): Optional timeout for performing a server-side operation.    Minimum is 1 millisecond; if set to a lower value, it corresponds to disabling the timeout.    A value of 0 disables the timeout (default value)

Raises:

ConnectionError: Raises with an error message when Reindexer instance is not initialized yetApiError: Raises with an error message of API return on non-zero error code

RxConnector.namespace_close

defnamespace_close(namespace:str,timeout:timedelta=timedelta(milliseconds=0))->None

Arguments:

namespace (string): The name of the namespacetimeout (`datetime.timedelta`): Optional timeout for performing a server-side operation.    Minimum is 1 millisecond; if set to a lower value, it corresponds to disabling the timeout.    A value of 0 disables the timeout (default value)

Raises:

ConnectionError: Raises with an error message when Reindexer instance is not initialized yetApiError: Raises with an error message of API return on non-zero error code

RxConnector.namespace_drop

defnamespace_drop(namespace:str,timeout:timedelta=timedelta(milliseconds=0))->None

Arguments:

namespace (string): The name of the namespacetimeout (`datetime.timedelta`): Optional timeout for performing a server-side operation.    Minimum is 1 millisecond; if set to a lower value, it corresponds to disabling the timeout.    A value of 0 disables the timeout (default value)

Raises:

Exception: Raises with an error message when Reindexer instance is not initialized yetException: Raises with an error message of API return on non-zero error code

RxConnector.namespaces_enum

defnamespaces_enum(enum_not_opened:bool=False,timeout:timedelta=timedelta(milliseconds=0))->List[Dict[str,str]]

Arguments:

enum_not_opened (bool, optional): An enumeration mode flag. If it is    set then closed namespaces are in result list too. Defaults to Falsetimeout (`datetime.timedelta`): Optional timeout for performing a server-side operation.    Minimum is 1 millisecond; if set to a lower value, it corresponds to disabling the timeout.    A value of 0 disables the timeout (default value)

Returns:

(:obj:`list` of :obj:`dict`): A list of dictionaries which describe each namespace

Raises:

ConnectionError: Raises with an error message when Reindexer instance is not initialized yetApiError: Raises with an error message of API return on non-zero error code

RxConnector.index_add

defindex_add(namespace:str,index_def:Dict,timeout:timedelta=timedelta(milliseconds=0))->None

Arguments:

namespace (string): The name of the namespaceindex_def (dict): A dictionary of index definitiontimeout (`datetime.timedelta`): Optional timeout for performing a server-side operation.    Minimum is 1 millisecond; if set to a lower value, it corresponds to disabling the timeout.    A value of 0 disables the timeout (default value)

Raises:

ConnectionError: Raises with an error message when Reindexer instance is not initialized yetApiError: Raises with an error message of API return on non-zero error code

RxConnector.index_update

defindex_update(namespace:str,index_def:Dict,timeout:timedelta=timedelta(milliseconds=0))->None

Arguments:

namespace (string): The name of the namespaceindex_def (dict): A dictionary of index definitiontimeout (`datetime.timedelta`): Optional timeout for performing a server-side operation.    Minimum is 1 millisecond; if set to a lower value, it corresponds to disabling the timeout.    A value of 0 disables the timeout (default value)

Raises:

ConnectionError: Raises with an error message when Reindexer instance is not initialized yetApiError: Raises with an error message of API return on non-zero error code

RxConnector.index_drop

defindex_drop(namespace:str,index_name:str,timeout:timedelta=timedelta(milliseconds=0))->None

Arguments:

namespace (string): The name of the namespaceindex_name (string): A name of an indextimeout (`datetime.timedelta`): Optional timeout for performing a server-side operation.    Minimum is 1 millisecond; if set to a lower value, it corresponds to disabling the timeout.    A value of 0 disables the timeout (default value)

Raises:

ConnectionError: Raises with an error message when Reindexer instance is not initialized yetApiError: Raises with an error message of API return on non-zero error code

RxConnector.item_insert

defitem_insert(namespace:str,item_def:Dict,precepts:List[str]=None,timeout:timedelta=timedelta(milliseconds=0))->None

Arguments:

namespace (string): The name of the namespaceitem_def (dict): A dictionary of item definitionprecepts (:obj:`list` of :obj:`str`): A dictionary of index definitiontimeout (`datetime.timedelta`): Optional timeout for performing a server-side operation.    Minimum is 1 millisecond; if set to a lower value, it corresponds to disabling the timeout.    A value of 0 disables the timeout (default value)

Raises:

ConnectionError: Raises with an error message when Reindexer instance is not initialized yetApiError: Raises with an error message of API return on non-zero error code

RxConnector.item_update

defitem_update(namespace:str,item_def:Dict,precepts:List[str]=None,timeout:timedelta=timedelta(milliseconds=0))->None

Arguments:

namespace (string): The name of the namespaceitem_def (dict): A dictionary of item definitionprecepts (:obj:`list` of :obj:`str`): A dictionary of index definitiontimeout (`datetime.timedelta`): Optional timeout for performing a server-side operation.    Minimum is 1 millisecond; if set to a lower value, it corresponds to disabling the timeout.    A value of 0 disables the timeout (default value)

Raises:

ConnectionError: Raises with an error message when Reindexer instance is not initialized yetApiError: Raises with an error message of API return on non-zero error code

RxConnector.item_upsert

defitem_upsert(namespace:str,item_def:Dict,precepts:List[str]=None,timeout:timedelta=timedelta(milliseconds=0))->None

Arguments:

namespace (string): The name of the namespaceitem_def (dict): A dictionary of item definitionprecepts (:obj:`list` of :obj:`str`): A dictionary of index definitiontimeout (`datetime.timedelta`): Optional timeout for performing a server-side operation.    Minimum is 1 millisecond; if set to a lower value, it corresponds to disabling the timeout.    A value of 0 disables the timeout (default value)

Raises:

ConnectionError: Raises with an error message when Reindexer instance is not initialized yetApiError: Raises with an error message of API return on non-zero error code

RxConnector.item_delete

defitem_delete(namespace:str,item_def:Dict,timeout:timedelta=timedelta(milliseconds=0))->None

Arguments:

namespace (string): The name of the namespaceitem_def (dict): A dictionary of item definitiontimeout (`datetime.timedelta`): Optional timeout for performing a server-side operation.    Minimum is 1 millisecond; if set to a lower value, it corresponds to disabling the timeout.    A value of 0 disables the timeout (default value)

Raises:

ConnectionError: Raises with an error message when Reindexer instance is not initialized yetApiError: Raises with an error message of API return on non-zero error code

RxConnector.meta_put

defmeta_put(namespace:str,key:str,value:str,timeout:timedelta=timedelta(milliseconds=0))->None

Arguments:

namespace (string): The name of the namespacekey (string): A key in a storage of Reindexer for metadata keepingvalue (string): A metadata for storagetimeout (`datetime.timedelta`): Optional timeout for performing a server-side operation.    Minimum is 1 millisecond; if set to a lower value, it corresponds to disabling the timeout.    A value of 0 disables the timeout (default value)

Raises:

ConnectionError: Raises with an error message when Reindexer instance is not initialized yetApiError: Raises with an error message of API return on non-zero error code

RxConnector.meta_get

defmeta_get(namespace:str,key:str,timeout:timedelta=timedelta(milliseconds=0))->str

Arguments:

namespace (string): The name of the namespacekey (string): A key in a storage of Reindexer where metadata is kepttimeout (`datetime.timedelta`): Optional timeout for performing a server-side operation.    Minimum is 1 millisecond; if set to a lower value, it corresponds to disabling the timeout.    A value of 0 disables the timeout (default value)

Returns:

string: A metadata value

Raises:

ConnectionError: Raises with an error message when Reindexer instance is not initialized yetApiError: Raises with an error message of API return on non-zero error code

RxConnector.meta_delete

defmeta_delete(namespace:str,key:str,timeout:timedelta=timedelta(milliseconds=0))->None

Arguments:

namespace (string): The name of the namespacekey (string): A key in a storage of Reindexer where metadata is kepttimeout (`datetime.timedelta`): Optional timeout for performing a server-side operation.    Minimum is 1 millisecond; if set to a lower value, it corresponds to disabling the timeout.    A value of 0 disables the timeout (default value)

Raises:

ConnectionError: Raises with an error message when Reindexer instance is not initialized yetApiError: Raises with an error message of API return on non-zero error code

RxConnector.meta_enum

defmeta_enum(namespace:str,timeout:timedelta=timedelta(milliseconds=0))->List[str]

Arguments:

namespace (string): The name of the namespacetimeout (`datetime.timedelta`): Optional timeout for performing a server-side operation.    Minimum is 1 millisecond; if set to a lower value, it corresponds to disabling the timeout.    A value of 0 disables the timeout (default value)

Returns:

(:obj:`list` of :obj:`str`): A list of all metadata keys

Raises:

ConnectionError: Raises with an error message when Reindexer instance is not initialized yetApiError: Raises with an error message of API return on non-zero error code

RxConnector.exec_sql

defexec_sql(query:str,timeout:timedelta=timedelta(milliseconds=0))->QueryResults

Arguments:

query (string): An SQL querytimeout (`datetime.timedelta`): Optional timeout for performing a server-side operation.    Minimum is 1 millisecond; if set to a lower value, it corresponds to disabling the timeout.    A value of 0 disables the timeout (default value)

Returns:

(:obj:`QueryResults`): A QueryResults iterator

Raises:

ConnectionError: Raises with an error message when Reindexer instance is not initialized yetApiError: Raises with an error message of API return on non-zero error code

RxConnector.new_transaction

defnew_transaction(namespace:str,timeout:timedelta=timedelta(milliseconds=0))->Transaction

Arguments:

namespace (string): The name of the namespacetimeout (`datetime.timedelta`): Optional timeout for performing a server-side operation.    Minimum is 1 millisecond; if set to a lower value, it corresponds to disabling the timeout.    A value of 0 disables the timeout (default value)

Returns:

(:obj:`Transaction`): A new transaction

Raises:

ConnectionError: Raises with an error message when Reindexer instance is not initialized yetApiError: Raises with an error message of API return on non-zero error code

RxConnector.new_query

defnew_query(namespace:str)->Query

Arguments:

namespace (string): The name of the namespace

Returns:

(:obj:`Query`): A new query

Raises:

ConnectionError: Raises with an error message when Reindexer instance is not initialized yet

pyreindexer.query_results

QueryResults Objects

classQueryResults()

Attributes:

api (module): An API module for Reindexer callserr_code (int): The API error codeerr_msg (string): The API error messageqres_wrapper_ptr (int): A memory pointer to Reindexer iterator objectqres_iter_count (int): A count of results for iterationspos (int): The current result position in iterator

QueryResults.status

defstatus()->None

Raises:

ApiError: Raises with an error message of API return on non-zero error code

QueryResults.count

defcount()->int

Returns

int: A count of results

QueryResults.total_count

deftotal_count()->int

Returns

int: A total or cached count of results

QueryResults.get_agg_results

defget_agg_results()->dict

Returns

(:obj:`dict`): Dictionary with all results for the current query

Raises:

ApiError: Raises with an error message of API return on non-zero error code

QueryResults.get_explain_results

defget_explain_results()->str

Returns

(string): Formatted string with explain of results for the current query

Raises:

ApiError: Raises with an error message of API return on non-zero error code

pyreindexer.transaction

Transaction Objects

classTransaction()

Attributes:

api (module): An API module for Reindexer callstransaction_wrapper_ptr (int): A memory pointer to Reindexer transaction objecterr_code (int): The API error codeerr_msg (string): The API error message

Transaction.insert

definsert(item_def:Dict,precepts:List[str]=None)->None

Arguments:

item_def (dict): A dictionary of item definitionprecepts (:obj:`list` of :obj:`str`): A dictionary of index definition

Raises:

TransactionError: Raises with an error message of API return if Transaction is overApiError: Raises with an error message of API return on non-zero error code

Transaction.update

defupdate(item_def:Dict,precepts:List[str]=None)->None

Arguments:

item_def (dict): A dictionary of item definitionprecepts (:obj:`list` of :obj:`str`): A dictionary of index definition

Raises:

TransactionError: Raises with an error message of API return if Transaction is overApiError: Raises with an error message of API return on non-zero error code

Transaction.update_query

defupdate_query(query:Query)->None

Arguments:

query (:obj:`Query`): A query object to modify

Raises:

TransactionError: Raises with an error message of API return if Transaction is overApiError: Raises with an error message of API return on non-zero error code

Transaction.upsert

defupsert(item_def:Dict,precepts:List[str]=None)->None

Arguments:

item_def (dict): A dictionary of item definitionprecepts (:obj:`list` of :obj:`str`): A dictionary of index definition

Raises:

TransactionError: Raises with an error message of API return if Transaction is overApiError: Raises with an error message of API return on non-zero error code

Transaction.delete

defdelete(item_def:Dict)->None

Arguments:

item_def (dict): A dictionary of item definition

Raises:

TransactionError: Raises with an error message of API return if Transaction is overApiError: Raises with an error message of API return on non-zero error code

Transaction.delete_query

defdelete_query(query:Query)

Arguments:

query (:obj:`Query`): A query object to modify

Raises:

TransactionError: Raises with an error message of API return if Transaction is overApiError: Raises with an error message of API return on non-zero error code

Transaction.commit

defcommit(timeout:timedelta=timedelta(milliseconds=0))->None

Arguments:

timeout (`datetime.timedelta`): Optional timeout for performing a server-side operation.    Minimum is 1 millisecond; if set to a lower value, it corresponds to disabling the timeout.    A value of 0 disables the timeout (default value)

Raises:

TransactionError: Raises with an error message of API return if Transaction is overApiError: Raises with an error message of API return on non-zero error code

Transaction.commit_with_count

defcommit_with_count(timeout:timedelta=timedelta(milliseconds=0))->int

Arguments:

timeout (`datetime.timedelta`): Optional timeout for performing a server-side operation.    Minimum is 1 millisecond; if set to a lower value, it corresponds to disabling the timeout.    A value of 0 disables the timeout (default value)

Raises:

TransactionError: Raises with an error message of API return if Transaction is overApiError: Raises with an error message of API return on non-zero error code

Transaction.rollback

defrollback(timeout:timedelta=timedelta(milliseconds=0))->None

Arguments:

timeout (`datetime.timedelta`): Optional timeout for performing a server-side operation.    Minimum is 1 millisecond; if set to a lower value, it corresponds to disabling the timeout.    A value of 0 disables the timeout (default value)

Raises:

TransactionError: Raises with an error message of API return if Transaction is overApiError: Raises with an error message of API return on non-zero error code

pyreindexer.point

Point Objects

classPoint()

Attributes:

x (float): x coordinate of the pointy (float): y coordinate of the point

pyreindexer.query

Query Objects

classQuery()

Attributes:

api (module): An API module for Reindexer callsquery_wrapper_ptr (int): A memory pointer to Reindexer query objecterr_code (int): The API error codeerr_msg (string): The API error messageroot (:object: Optional[`Query`]): The root query of the Reindexer queryjoin_queries (list[:object:`Query`]): The list of join Reindexer query objectsmerged_queries (list[:object:`Query`]): The list of merged Reindexer query objects

Query.where

defwhere(index:str,condition:CondType,keys:Union[simple_types,tuple[list[simple_types],                                        ...]]=None)->Query

Arguments:

index (string): Field name used in condition clausecondition (:enum:`CondType`): Type of conditionkeys (union[simple_types, (list[simple_types], ...)]):    Value of index to be compared with. For composite indexes keys must be list,    with value of each sub-index

Returns:

(:obj:`Query`): Query object for further customizations

Raises:

ApiError: Raises with an error message of API return on non-zero error code

Query.where_query

defwhere_query(sub_query:Query,condition:CondType,keys:Union[simple_types,tuple[list[simple_types],                                        ...]]=None)->Query

Arguments:

sub_query (:obj:`Query`): Field name used in condition clausecondition (:enum:`CondType`): Type of conditionkeys (union[simple_types, (list[simple_types], ...)]):    Value of index to be compared with. For composite indexes keys must be list,    with value of each sub-index

Returns:

(:obj:`Query`): Query object for further customizations

Raises:

ApiError: Raises with an error message of API return on non-zero error code

Query.where_subquery

defwhere_subquery(index:str,condition:CondType,sub_query:Query)->Query

Arguments:

index (string): Field name used in condition clausecondition (:enum:`CondType`): Type of conditionsub_query (:obj:`Query`): Field name used in condition clause

Returns:

(:obj:`Query`): Query object for further customizations

Query.where_composite

defwhere_composite(index:str,condition:CondType,keys:tuple[list[simple_types], ...])->Query

Arguments:

index (string): Field name used in condition clausecondition (:enum:`CondType`): Type of conditionkeys (list[simple_types], ...): Values of composite index to be compared with (value of each sub-index).    Supported variants:        ([1, "test1"], [2, "test2"])        [[1, "test1"], [2, "test2"]])        ([1, "testval1"], )        [[1, "testval1"]]        (1, "testval1")

Returns:

(:obj:`Query`): Query object for further customizations

Raises:

ApiError: Raises with an error message of API return on non-zero error code

Query.where_uuid

defwhere_uuid(index:str,condition:CondType,*uuids:UUID)->Query

Arguments:

index (string): Field name used in condition clausecondition (:enum:`CondType`): Type of conditionuuids (*:obj:`UUID`): Value of index to be compared with. For composite indexes uuids must be list,    with value of each sub-index

Returns:

(:obj:`Query`): Query object for further customizations

Raises:

ApiError: Raises with an error message of API return on non-zero error code

Query.where_between_fields

defwhere_between_fields(first_field:str,condition:CondType,second_field:str)->Query

Arguments:

first_field (string): First field name used in condition clausecondition (:enum:`CondType`): Type of conditionsecond_field (string): Second field name used in condition clause

Returns:

(:obj:`Query`): Query object for further customizations

Query.where_knn

defwhere_knn(index:str,vec:List[float],param:Union[IndexSearchParamBruteForce|IndexSearchParamHnsw|IndexSearchParamIvf])->Query

Arguments:

index (string): Field name used in condition clause (only float_vector)vec (list[float]): KNN value of index to be compared withparam (:obj:`union[IndexSearchParamBruteForce|IndexSearchParamHnsw|IndexSearchParamIvf]`): KNN search parameters

Returns:

(:obj:`Query`): Query object for further customizations

Raises:

QueryError: Raises with an error message if no vec are specifiedQueryError: Raises with an error message if no param are specified or have an invalid valueApiError: Raises with an error message of API return on non-zero error code

Query.where_knn_string

defwhere_knn_string(index:str,value:str,param:Union[IndexSearchParamBruteForce|IndexSearchParamHnsw|IndexSearchParamIvf])->Query

Arguments:

index (string): Field name used in condition clause (only float_vector)value (string): value to be generated using automatic embedding of KNN index value to be compared toparam (:obj:`union[IndexSearchParamBruteForce|IndexSearchParamHnsw|IndexSearchParamIvf]`): KNN search parameters

Returns:

(:obj:`Query`): Query object for further customizations

Raises:

QueryError: Raises with an error message if no value are specifiedQueryError: Raises with an error message if no param are specified or have an invalid valueApiError: Raises with an error message of API return on non-zero error code

Query.open_bracket

defopen_bracket()->Query

Returns:

(:obj:`Query`): Query object for further customizations

Raises:

ApiError: Raises with an error message of API return on non-zero error code

Query.close_bracket

defclose_bracket()->Query

Returns:

(:obj:`Query`): Query object for further customizations

Raises:

ApiError: Raises with an error message of API return on non-zero error code

Query.match

defmatch(index:str,*keys:str)->Query

Arguments:

index (string): Field name used in condition clausekeys (*string): Value of index to be compared with. For composite indexes keys must be list,    with value of each sub-index

Returns:

(:obj:`Query`): Query object for further customizations

Raises:

ApiError: Raises with an error message of API return on non-zero error code

Query.dwithin

defdwithin(index:str,point:Point,distance:float)->Query

Arguments:

index (string): Field name used in condition clausepoint (:obj:`Point`): Point object used in condition clausedistance (float): Distance in meters between point

Returns:

(:obj:`Query`): Query object for further customizations

Query.distinct

defdistinct(index:str)->Query

Arguments:

index (string): Field name for distinct operation

Returns:

(:obj:`Query`): Query object for further customizations

Query.aggregate_sum

defaggregate_sum(index:str)->Query

Arguments:

index (string): Field name for sum operation

Returns:

(:obj:`Query`): Query object for further customizations

Query.aggregate_avg

defaggregate_avg(index:str)->Query

Arguments:

index (string): Field name for sum operation

Returns:

(:obj:`Query`): Query object for further customizations

Query.aggregate_min

defaggregate_min(index:str)->Query

Arguments:

index (string): Field name for sum operation

Returns:

(:obj:`Query`): Query object for further customizations

Query.aggregate_max

defaggregate_max(index:str)->Query

Arguments:

index (string): Field name for sum operation

Returns:

(:obj:`Query`): Query object for further customizations

Query.aggregate_facet

defaggregate_facet(*fields:str)->Query._AggregateFacet

Arguments:

fields (*string): Fields any data column name or `count`, fields should not be empty

Returns:

(:obj:`_AggregateFacet`): Request object for further customizations

Query.sort

defsort(index:str,desc:bool=False,forced_sort_values:Union[simple_types,tuple[list[simple_types],                                                  ...]]=None)->Query

Arguments:

index (string): The index namedesc (bool): Sort in descending orderforced_sort_values (union[simple_types, (list[simple_types], ...)]):    Value of index to match. For composite indexes keys must be list, with value of each sub-index

Returns:

(:obj:`Query`): Query object for further customizations

Raises:

ApiError: Raises with an error message of API return on non-zero error code

Query.sort_stpoint_distance

defsort_stpoint_distance(index:str,point:Point,desc:bool)->Query

Arguments:

index (string): The index namepoint (:obj:`Point`): Point object used in sorting operationdesc (bool): Sort in descending order

Returns:

(:obj:`Query`): Query object for further customizations

Query.sort_stfield_distance

defsort_stfield_distance(first_field:str,second_field:str,desc:bool)->Query

Arguments:

first_field (string): First field name used in conditionsecond_field (string): Second field name used in conditiondesc (bool): Sort in descending order

Returns:

(:obj:`Query`): Query object for further customizations

Raises:

ApiError: Raises with an error message of API return on non-zero error code

Query.op_and

defop_and()->Query

Returns:

(:obj:`Query`): Query object for further customizations

Query.op_or

defop_or()->Query

Returns:

(:obj:`Query`): Query object for further customizations

Query.op_not

defop_not()->Query

Returns:

(:obj:`Query`): Query object for further customizations

Query.request_total

defrequest_total()->Query

Arguments:

total_name (string, optional): Name to be requested

Returns:

(:obj:`Query`): Query object for further customizations

Query.cached_total

defcached_total()->Query

Arguments:

total_name (string, optional): Name to be requested

Returns:

(:obj:`Query`): Query object for further customizations

Query.limit

deflimit(limit_items:int)->Query

Arguments:

limit_items (int): Number of rows to get from result set

Returns:

(:obj:`Query`): Query object for further customizations

Query.offset

defoffset(start_offset:int)->Query

Arguments:

limit_items (int): Index of the first row to get from result set

Returns:

(:obj:`Query`): Query object for further customizations

Query.debug

defdebug(level:LogLevel)->Query

Arguments:

level (:enum:`LogLevel`): Debug log level on server

Returns:

(:obj:`Query`): Query object for further customizations

Query.strict

defstrict(mode:StrictMode)->Query

Arguments:

mode (:enum:`StrictMode`): Strict mode

Returns:

(:obj:`Query`): Query object for further customizations

Query.explain

defexplain()->Query

Returns:

(:obj:`Query`): Query object for further customizations

Query.with_rank

defwith_rank()->Query

Returns:

(:obj:`Query`): Query object for further customizations

Query.execute

defexecute(timeout:timedelta=timedelta(milliseconds=0))->QueryResults

Arguments:

timeout (`datetime.timedelta`): Optional timeout for performing a server-side operation.    Minimum is 1 millisecond; if set to a lower value, it corresponds to disabling the timeout.    A value of 0 disables the timeout (default value)

Returns:

(:obj:`QueryResults`): A QueryResults iterator

Raises:

ApiError: Raises with an error message when query is in an invalid stateApiError: Raises with an error message of API return on non-zero error code

Query.delete

defdelete(timeout:timedelta=timedelta(milliseconds=0))->int

Arguments:

timeout (`datetime.timedelta`): Optional timeout for performing a server-side operation.    Minimum is 1 millisecond; if set to a lower value, it corresponds to disabling the timeout.    A value of 0 disables the timeout (default value)

Returns:

(int): Number of deleted elements

Raises:

QueryError: Raises with an error message when query is in an invalid stateApiError: Raises with an error message of API return on non-zero error code

Query.set_object

defset_object(field:str,values:list[simple_types])->Query

Arguments:

field (string): Field namevalues (list[simple_types]): List of values to add

Returns:

(:obj:`Query`): Query object for further customizations

Raises:

QueryError: Raises with an error message if no values are specifiedApiError: Raises with an error message of API return on non-zero error code

Query.set

defset(field:str,values:list[simple_types])->Query

Arguments:

field (string): Field namevalues (list[simple_types]): List of values to add

Returns:

(:obj:`Query`): Query object for further customizations

Raises:

ApiError: Raises with an error message of API return on non-zero error code

Query.drop

defdrop(index:str)->Query

Arguments:

index (string): Field name for drop operation

Returns:

(:obj:`Query`): Query object for further customizations

Query.expression

defexpression(field:str,value:str)->Query

Arguments:

field (string): Field namevalue (string): New value expression for field

Returns:

(:obj:`Query`): Query object for further customizations

Query.update

defupdate(timeout:timedelta=timedelta(milliseconds=0))->QueryResults

Arguments:

timeout (`datetime.timedelta`): Optional timeout for performing a server-side operation.    Minimum is 1 millisecond; if set to a lower value, it corresponds to disabling the timeout.    A value of 0 disables the timeout (default value)

Returns:

(:obj:`QueryResults`): A QueryResults iterator

Raises:

QueryError: Raises with an error message when query is in an invalid stateApiError: Raises with an error message of API return on non-zero error code

Query.must_execute

defmust_execute(timeout:timedelta=timedelta(milliseconds=0))->QueryResults

Arguments:

timeout (`datetime.timedelta`): Optional timeout for performing a server-side operation.    Minimum is 1 millisecond; if set to a lower value, it corresponds to disabling the timeout.    A value of 0 disables the timeout (default value)

Returns:

(:obj:`QueryResults`): A QueryResults iterator

Raises:

ApiError: Raises with an error message when query is in an invalid stateApiError: Raises with an error message of API return on non-zero error code

Query.get

defget(timeout:timedelta=timedelta(milliseconds=0))-> (str,bool)

Arguments:

timeout (`datetime.timedelta`): Optional timeout for performing a server-side operation.    Minimum is 1 millisecond; if set to a lower value, it corresponds to disabling the timeout.    A value of 0 disables the timeout (default value)

Returns:

(:tuple:string,bool): 1st string item and found flag

Raises:

ApiError: Raises with an error message when query is in an invalid stateApiError: Raises with an error message of API return on non-zero error code

Query.inner_join

definner_join(query:Query,field:str)->Query

Arguments:

query (:obj:`Query`): Query object to left joinfield (string): Joined field name. As unique identifier for the join between this query and `join_query`.    Parameter in order for InnerJoin to work: namespace of `query` contains `field` as one of its fields    marked as `joined`

Returns:

(:obj:`Query`): Query object for further customizations

Query.join

defjoin(query:Query,field:str)->Query

Arguments:

query (:obj:`Query`): Query object to left joinfield (string): Joined field name. As unique identifier for the join between this query and `join_query`

Returns:

(:obj:`Query`): Query object for further customizations

Query.left_join

defleft_join(join_query:Query,field:str)->Query

Arguments:

query (:obj:`Query`): Query object to left joinfield (string): Joined field name. As unique identifier for the join between this query and `join_query`

Returns:

(:obj:`Query`): Query object for further customizations

Query.merge

defmerge(query:Query)->Query

Arguments:

query (:obj:`Query`): Query object to merge

Returns:

(:obj:`Query`): Query object for further customizations

Query.on

defon(index:str,condition:CondType,join_index:str)->Query

Arguments:

index (string): Field name from `Query` namespace should be used during joincondition (:enum:`CondType`): Type of condition, specifies how `Query` will be joined with the latest join query issued on `Query` (e.g. `EQ`/`GT`/`SET`/...)join_index (string): Index-field name from namespace for the latest join query issued on `Query` should be used during join

Returns:

(:obj:`Query`): Query object for further customizations

Raises:

QueryError: Raises with an error message when query is in an invalid state

Query.select_fields

defselect_fields(*fields:str)->Query

Arguments:

fields (*string): List of columns to be selected

Returns:

(:obj:`Query`): Query object for further customizations

Raises:

ApiError: Raises with an error message of API return on non-zero error code

Query.functions

deffunctions(*functions:str)->Query

Arguments:

functions (*string): Functions declaration

Returns:

(:obj:`Query`): Query object for further customizations

Raises:

ApiError: Raises with an error message of API return on non-zero error code

Query.equal_position

defequal_position(*equal_position:str)->Query

Arguments:

equal_poses (*string): Equal position fields to arrays queries

Returns:

(:obj:`Query`): Query object for further customizations

Raises:

ApiError: Raises with an error message of API return on non-zero error code

pyreindexer.index_search_params

IndexSearchParamBruteForce Objects

classIndexSearchParamBruteForce()

Attributes:

k (int): Expected size of KNN index results. Should not be less than 1radius (float): In addition to the parameter `k`, the query results can also be filtered by a `rank` -  value using the parameter, witch called `radius`. It's named so because, under the `L2`-metric,  it restricts vectors from query result to a sphere of the specified radius. [More about `radius`]  (https://github.com/Restream/reindexer/blob/master/float_vector.md)

IndexSearchParamHnsw Objects

classIndexSearchParamHnsw()

Attributes:

k (int): Expected size of KNN index results. Should not be less than 1ef (int): Size of nearest neighbor buffer that will be filled during fetching. Should not be less than 'k',good story when `ef` ~= 1.5 * `k`radius (float): In addition to the parameter `k`, the query results can also be filtered by a `rank` -  value using the parameter, witch called `radius`. It's named so because, under the `L2`-metric,  it restricts vectors from query result to a sphere of the specified radius. [More about `radius`]  (https://github.com/Restream/reindexer/blob/master/float_vector.md)

IndexSearchParamIvf Objects

classIndexSearchParamIvf()

Attributes:

k (int): Expected size of KNN index results. Should not be less than 1nprobe (int): Number of centroids that will be scanned in where. Should not be less than 1radius (float): In addition to the parameter `k`, the query results can also be filtered by a `rank` -  value using the parameter, witch called `radius`. It's named so because, under the `L2`-metric,  it restricts vectors from query result to a sphere of the specified radius. [More about `radius`]  (https://github.com/Restream/reindexer/blob/master/float_vector.md)

pyreindexer.index_definition

IndexDefinition Objects

classIndexDefinition(dict)

Arguments:

name (str): An index name.json_paths (:obj:`list` of :obj:`str`): A name for mapping a value to a json field.field_type (str): A type of field. Possible values are: `int`, `int64`, `double`, `string`, `bool`,`composite`, `float_vector`.index_type (str): An index type. Possible values are: `hash`, `tree`, `text`, `-`, `hnsw`, `vec_bf`, `ivf`.is_pk (bool): True if a field is a primary key.is_array (bool): True if an index is an array.is_dense (bool): True if an index is dense. Reduce the index size. Saves 8 bytes per unique key value for 'hash'    and 'tree' index types. For '-' index type saves 4-8 bytes per each element. Useful for indexes with    high selectivity, but for tree and hash indexes with low selectivity can seriously decrease update    performance.is_no_column (bool): True if allows to disable column subindex. Reduces the index size.    Allows to save ~(`stored_type_size` * `namespace_items_count`) bytes, where `stored_type_size` is the size    of the type stored in the index, and `namespace_items_count` is the number of items in the namespace.    May reduce performance.is_sparse (bool): True if a value of an index may be not presented.collate_mode (str): Sets an order of values by collate mode. Possible values are:    `none`, `ascii`, `utf8`, `numeric`, `custom`.sort_order_letters (str): Order for a sort sequence for a custom collate mode.config (dict): A config for a fulltext and float_vector engine.[More about `fulltext`](https://github.com/Restream/reindexer/blob/master/fulltext.md) or[More about `float_vector`](https://github.com/Restream/reindexer/blob/master/float_vector.md).