btrievePython 16.10.30.0b0__tar.gz → 16.10.30.0b1__tar.gz

{btrievepython-16.10.30.0b0/btrievePython.egg-info → btrievepython-16.10.30.0b1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: btrievePython
-Version: 16.10.30.0b0
+Version: 16.10.30.0b1
 Summary: Btrieve Python provides a Client API for Actian Zen
 Home-page: https://www.actian.com/databases/zen
 Author: Actian Corporation

{btrievepython-16.10.30.0b0 → btrievepython-16.10.30.0b1}/btrievePython/__init__.py

@@ -64,6 +64,9 @@ class _SwigNonDynamicMeta(type):
 
 def buffer_view_attach(view: "Py_buffer *", obj: "PyObject *", buffer: "char **", size: "Py_ssize_t *") -> "int":
     return _btrievePython.buffer_view_attach(view, obj, buffer, size)
+
+def buffer_view_attach_const(view: "Py_buffer *", obj: "PyObject *", buffer: "char const **", size: "Py_ssize_t *") -> "int":
+    return _btrievePython.buffer_view_attach_const(view, obj, buffer, size)
 class Btrieve(object):
     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
@@ -534,6 +537,7 @@ class Btrieve(object):
     STATUS_CODE_UT_THUNK_NOT_LOADED = _btrievePython.Btrieve_STATUS_CODE_UT_THUNK_NOT_LOADED
     STATUS_CODE_NO_RESOURCE_DLL = _btrievePython.Btrieve_STATUS_CODE_NO_RESOURCE_DLL
     STATUS_CODE_OS_ERROR = _btrievePython.Btrieve_STATUS_CODE_OS_ERROR
+    STATUS_CODE_FILTER_LIMIT_EXCEEDED = _btrievePython.Btrieve_STATUS_CODE_FILTER_LIMIT_EXCEEDED
     STATUS_CODE_MK_ROUTER_MEM_ERROR = _btrievePython.Btrieve_STATUS_CODE_MK_ROUTER_MEM_ERROR
     STATUS_CODE_MK_NO_LOCAL_ACCESS_ALLOWED = _btrievePython.Btrieve_STATUS_CODE_MK_NO_LOCAL_ACCESS_ALLOWED
     STATUS_CODE_MK_NO_RESOURCE_DLL = _btrievePython.Btrieve_STATUS_CODE_MK_NO_RESOURCE_DLL
@@ -1847,22 +1851,22 @@ class BtrieveSpace(object):
     def SetLastStatusCode(self, statusCode: "Btrieve::StatusCode") -> "Btrieve::StatusCode":
         return _btrievePython.BtrieveSpace_SetLastStatusCode(self, statusCode)
 
-    def EuclideanDistanceSimilarity(self, vector: "char const *", limit: "int", query: "char const *"=None) -> "char const *":
+    def EuclideanDistanceSimilarity(self, vector: "char const *", limit: "int", query: "char const *"=None) -> "std::string":
         return _btrievePython.BtrieveSpace_EuclideanDistanceSimilarity(self, vector, limit, query)
 
-    def CosineSimilarity(self, vector: "char const *", limit: "int", query: "char const *"=None) -> "char const *":
+    def CosineSimilarity(self, vector: "char const *", limit: "int", query: "char const *"=None) -> "std::string":
         return _btrievePython.BtrieveSpace_CosineSimilarity(self, vector, limit, query)
 
-    def DotProductSimilarity(self, vector: "char const *", limit: "int", query: "char const *"=None) -> "char const *":
+    def DotProductSimilarity(self, vector: "char const *", limit: "int", query: "char const *"=None) -> "std::string":
         return _btrievePython.BtrieveSpace_DotProductSimilarity(self, vector, limit, query)
 
     def VectorCreate(self, *args) -> "int":
         return _btrievePython.BtrieveSpace_VectorCreate(self, *args)
 
-    def VectorRetrieveBlob(self, id: "int", blobObject: "PyObject *", vectorBlobOffset: "int"=0, vectorBlobLength: "int"=0) -> "Btrieve::StatusCode":
-        return _btrievePython.BtrieveSpace_VectorRetrieveBlob(self, id, blobObject, vectorBlobOffset, vectorBlobLength)
+    def VectorRetrieveBlob(self, *args) -> "Btrieve::StatusCode":
+        return _btrievePython.BtrieveSpace_VectorRetrieveBlob(self, *args)
 
-    def VectorRetrieveJson(self, *args) -> "char const *":
+    def VectorRetrieveJson(self, *args) -> "std::string":
         return _btrievePython.BtrieveSpace_VectorRetrieveJson(self, *args)
 
     def VectorUpdate(self, *args) -> "Btrieve::StatusCode":

{btrievepython-16.10.30.0b0 → btrievepython-16.10.30.0b1}/btrievePython/btrieveC.h

@@ -403,6 +403,8 @@ typedef enum {
     BTRIEVE_STATUS_CODE_NO_RESOURCE_DLL = 2011,
     /// \brief 2012 - Operating system error.
     BTRIEVE_STATUS_CODE_OS_ERROR = 2012,
+    /// \brief 2013 - Filter limit exceeded.
+    BTRIEVE_STATUS_CODE_FILTER_LIMIT_EXCEEDED = 2013,
     /// \brief 3000 - MicroKernel router memory error.
     BTRIEVE_STATUS_CODE_MK_ROUTER_MEM_ERROR = 3000,
     /// \brief 3001 - MicroKernel no local access allowed.
@@ -2310,7 +2312,7 @@ extern LINKAGE btrieve_status_code_t BtrieveFileBulkRetrieveNext(btrieve_file_t
 /// \param[in] file The file. See BtrieveClientFileOpen().
 /// \param[in] comparison The comparison.
 /// \param[in] index The index.
-/// \param[in] key The key.
+/// \param[inout] key The key.
 /// \param[in] keyLength The key length.
 /// \param[in] bulkRetrieveAttributes The bulk retrieve attributes. See BtrieveBulkRetrieveAttributesAllocate().
 /// \param[out] bulkRetrieveResult The bulk retrieve result. See BtrieveBulkRetrieveResultAllocate().
@@ -2342,7 +2344,7 @@ extern LINKAGE btrieve_status_code_t BtrieveFileBulkRetrievePrevious(btrieve_fil
 /// \param[in] file The file. See BtrieveClientFileOpen().
 /// \param[in] comparison The comparison.
 /// \param[in] index The index.
-/// \param[in] key The key.
+/// \param[inout] key The key.
 /// \param[in] keyLength The key length.
 /// \param[in] bulkRetrieveAttributes The bulk retrieve attributes. See BtrieveBulkRetrieveAttributesAllocate().
 /// \param[out] bulkRetrieveResult The bulk retrieve result. See BtrieveBulkRetrieveResultAllocate().
@@ -2403,7 +2405,7 @@ extern LINKAGE btrieve_status_code_t BtrieveFileBulkDeleteNext(btrieve_file_t fi
 /// \param[in] file The file. See BtrieveClientFileOpen().
 /// \param[in] comparison The comparison.
 /// \param[in] index The index.
-/// \param[in] key The key.
+/// \param[inout] key The key.
 /// \param[in] keyLength The key length.
 /// \param[in] bulkDeleteAttributes The bulk delete attributes. See BtrieveBulkDeleteAttributesAllocate().
 /// \param[out] bulkDeleteResult The bulk delete result. See BtrieveBulkDeleteResultAllocate().
@@ -2433,7 +2435,7 @@ extern LINKAGE btrieve_status_code_t BtrieveFileBulkDeletePrevious(btrieve_file_
 /// \param[in] file The file. See BtrieveClientFileOpen().
 /// \param[in] comparison The comparison.
 /// \param[in] index The index.
-/// \param[in] key The key.
+/// \param[inout] key The key.
 /// \param[in] keyLength The key length.
 /// \param[in] bulkDeleteAttributes The bulk delete attributes. See BtrieveBulkDeleteAttributesAllocate().
 /// \param[out] bulkDeleteResult The bulk delete result. See BtrieveBulkDeleteResultAllocate().

{btrievepython-16.10.30.0b0 → btrievepython-16.10.30.0b1}/btrievePython/btrieveCpp.h

@@ -14,6 +14,7 @@
 
 #include <cstddef>
 #include <deque>
+#include <string>
 
 #include "btrieveC.h"
 
@@ -1081,6 +1082,8 @@ public:
       STATUS_CODE_NO_RESOURCE_DLL = 2011,
 		/// \brief 2012 - Operating system error.
       STATUS_CODE_OS_ERROR = 2012,
+      /// \brief 2013 - Filter limit exceeded.
+      STATUS_CODE_FILTER_LIMIT_EXCEEDED = 2013,
 		/// \brief 3000 - MicroKernel router memory error.
       STATUS_CODE_MK_ROUTER_MEM_ERROR = 3000,
 		/// \brief 3001 - MicroKernel no local access allowed.
@@ -1399,6 +1402,8 @@ public:
    /// \param[in] clientIdentifier The client identifier. Use 0 to automatically generate a client identifier based on the caller's thread identifier.
    /// \SNIPPET_CPP_PYTHON{BtrieveClient, btest.cpp, btest.py}
    BtrieveClient(int serviceAgentIdentifier, int clientIdentifier);
+   /// \par
+   /// Any open collections, files or spaces will remain open. See BtrieveClient::CollectionClose, BtrieveClient::FileClose, and BtrieveClient::SpaceClose. Also see BtrieveClient::Reset.
    ~BtrieveClient();
 
    /// \brief Get the version.
@@ -5089,10 +5094,12 @@ private:
 /// ----------      | ------------- | ---------------- | ------- | ------------------ | ----   | -----------
 /// _blobLength     | no            | yes              | yes     | yes                | number | The vector blob length.
 /// _createTime     | no            | yes              | yes     | yes                | number | The vector create time in microseconds since the Unix Epoch.
-/// _id             | no            | yes              | yes     | no                 | number | The vector identifier.
+/// _id             | yes           | yes              | yes     | no                 | number | The vector identifier.
 /// _jsonLength     | no            | yes              | yes     | yes                | number | The vector json length.
 /// _label          | yes           | no               | yes     | yes                | string | The vector label.
 /// _updateTime     | no            | yes              | yes     | yes                | number | The vector update time in microseconds since the Unix Epoch.
+/// _uuid           | yes           | yes              | yes     | no                 | string | The vector universally unique identifier.
+/// _vector         | yes           | no               | no      | yes                | array  | The vector as an array of numbers.
 /// \details
 /// Non-user settable JSON field names are silently ignored by BtrieveSpace::VectorCreate and BtrieveSpace::VectorUpdate.
 /// Use of reserved JSON field names other than those listed above will generate an error.
@@ -5137,39 +5144,44 @@ public:
    /// \retval "!= Btrieve::STATUS_CODE_NO_ERROR" \ERROR_HAS_OCCURRED
    /// \see Btrieve::StatusCodeToString
    Btrieve::StatusCode VectorRetrieveBlob(int id, char *blob, int blobSize, int vectorBlobOffset = 0, int vectorBlobLength = 0);
+   /// \brief Retrieve a vector blob.
+   /// \param[in] uuid The universally unique identifier.
+   /// \param[out] blob The blob. 
+   /// \param[in] blobSize The blob size.
+   /// \param[in] vectorBlobOffset The vector blob offset.
+   /// \param[in] vectorBlobLength The vector blob length. If vector blob length is 0, then the entire vector blob will be retrieved beginning at vector blob offset.
+   /// \retval "= Btrieve::STATUS_CODE_NO_ERROR" \SUCCESS
+   /// \retval "!= Btrieve::STATUS_CODE_NO_ERROR" \ERROR_HAS_OCCURRED
+   /// \see Btrieve::StatusCodeToString
+   Btrieve::StatusCode VectorRetrieveBlob(const char *uuid, char *blob, int blobSize, int vectorBlobOffset = 0, int vectorBlobLength = 0);
    /// \brief Retrieve a vector json.
-   /// \note This method is not thread safe. The string returned will be overwritten on subsequent calls.
    /// \param[in] id The identifier.
-   /// \retval "!= NULL" The json.
-   /// \retval NULL \ERROR_HAS_OCCURRED
-   const char *VectorRetrieveJson(int id);
+   /// \retval !="" The json.
+   /// \retval "" \ERROR_HAS_OCCURRED
+   std::string VectorRetrieveJson(int id);
+   /// \brief Retrieve a vector json.
+   /// \param[in] uuid The universally unique identifier.
+   /// \retval !="" The json.
+   /// \retval "" \ERROR_HAS_OCCURRED
+   std::string VectorRetrieveJson(const char *uuid);
    /// \brief Retrieve a vector json.
-   /// \note This method is not thread safe. The string returned will be overwritten on subsequent calls.
    /// \param[in] id The identifier.
    /// \param[out] blob The blob.
    /// \param[in] blobSize The blob size.
    /// \param[in] vectorBlobOffset The vector blob offset.
    /// \param[in] vectorBlobLength The vector blob length. If vector blob length is 0, then the entire vector blob will be retrieved beginning at vector blob offset.
-   /// \retval "!= NULL" The json.
-   /// \retval NULL \ERROR_HAS_OCCURRED
-   const char *VectorRetrieveJson(int id, char *blob, int blobSize, int vectorBlobOffset = 0, int vectorBlobLength = 0);
-#ifndef SWIG
-   /// \brief Retrieve a vector.
-   /// \note \METHOD_ONLY_CPP
-   /// \param[in] id The identifier.
-   /// \param[out] json The json.
-   /// \param[in] jsonSize The json size.
+   /// \retval !="" The json.
+   /// \retval "" \ERROR_HAS_OCCURRED
+   std::string VectorRetrieveJson(int id, char *blob, int blobSize, int vectorBlobOffset = 0, int vectorBlobLength = 0);
+   /// \brief Retrieve a vector json.
+   /// \param[in] uuid The universally unique identifier.
    /// \param[out] blob The blob.
    /// \param[in] blobSize The blob size.
    /// \param[in] vectorBlobOffset The vector blob offset.
    /// \param[in] vectorBlobLength The vector blob length. If vector blob length is 0, then the entire vector blob will be retrieved beginning at vector blob offset.
-   /// \par \DESCRIPTION
-   /// Remember to allocate enough space to retrieve not only the vector JSON but also the reserved JSON field names and values, e.g. "_bloblength" : 1234567890.
-   /// \retval "= Btrieve::STATUS_CODE_NO_ERROR" \SUCCESS
-   /// \retval "!= Btrieve::STATUS_CODE_NO_ERROR" \ERROR_HAS_OCCURRED
-   /// \see Btrieve::StatusCodeToString
-   Btrieve::StatusCode VectorRetrieve(int id, char *json = NULL, int jsonSize = 0, char *blob = NULL, int blobSize = 0, int vectorBlobOffset = 0, int vectorBlobLength = 0);
-#endif
+   /// \retval !="" The json.
+   /// \retval "" \ERROR_HAS_OCCURRED
+   std::string VectorRetrieveJson(const char *uuid, char *blob, int blobSize, int vectorBlobOffset = 0, int vectorBlobLength = 0);
    /// \brief Retrieve a vector entity tag.
    /// \param[in] id The identifier.
    /// \retval ">= 0" The vector entity tag.
@@ -5275,12 +5287,16 @@ public:
    ///      "_sortOrder" : "descending" |
    ///      "_updateTime" : <number> | 
    ///      "_updateTime" : { <time_operator> : <number> }
+   ///      "_uuid" : <string> | 
+   ///      "_uuid" : { <uuid_operator> : <string> } |
    ///
-   ///   <sort_field> := "_blobLength" | "_createTime" | "_id" | "_jsonLength" | "_label" | "_updateTime"
+   ///   <sort_field> := "_blobLength" | "_createTime" | "_id" | "_jsonLength" | "_label" | "_updateTime" | "_uuid"
    ///
    ///   <time_operator> ::= "$eq" | "$gt" | "$gte" | "$lt" | "$lte"
    ///
    ///   <string_operator> ::= "$eq" | "$gt" | "$gte" | "$like" | "$lt" | "$lte" | "$ne" | "$notlike"
+   ///
+   ///   <uuid_operator> ::= "$eq" | "$gt" | "$gte" | "$lt" | "$lte" | "$ne"
    /// \endcode
    /// \par
    /// In a JSON expression, if the query value is not an array and the vector value is an array then each element in the array is evaluated. If any evaluation returns true then the JSON expression returns true.
@@ -5322,41 +5338,42 @@ public:
    Btrieve::StatusCode SetLastStatusCode(Btrieve::StatusCode statusCode);
 /// \endcond
    /// \brief Calculate the Euclidean distance similarity.
-   /// \note This method is not thread safe. The string returned will be overwritten on subsequent calls.
    /// \param[in] vector The vector.
    /// \param[in] limit The limit.
    /// \param[in] query The query. See BtrieveSpace::Query.
-   /// \retval "!= NULL" The similarity.
-   /// \retval NULL \ERROR_HAS_OCCURRED
+   /// \retval !="" The json.
+   /// \retval "" \ERROR_HAS_OCCURRED
    /// \TO_DETERMINE_STATUS_CODE{BtrieveSpace::GetLastStatusCode}
-   const char *EuclideanDistanceSimilarity(const char *vector, int limit, const char *query = NULL);
+   std::string EuclideanDistanceSimilarity(const char *vector, int limit, const char *query = NULL);
    /// \brief Calculate the cosine similarity.
-   /// \note This method is not thread safe. The string returned will be overwritten on subsequent calls.
    /// \param[in] vector The vector.
    /// \param[in] limit The limit.
    /// \param[in] query The query. See BtrieveSpace::Query.
-   /// \retval "!= NULL" The similarity.
-   /// \retval NULL \ERROR_HAS_OCCURRED
+   /// \retval !="" The json.
+   /// \retval "" \ERROR_HAS_OCCURRED
    /// \TO_DETERMINE_STATUS_CODE{BtrieveSpace::GetLastStatusCode}
-   const char *CosineSimilarity(const char *vector, int limit, const char *query = NULL);
+   std::string CosineSimilarity(const char *vector, int limit, const char *query = NULL);
    /// \brief Calculate the dot product similarity.
-   /// \note This method is not thread safe. The string returned will be overwritten on subsequent calls.
    /// \param[in] vector The vector.
    /// \param[in] limit The limit.
    /// \param[in] query The query. See BtrieveSpace::Query.
-   /// \retval "!= NULL" The similarity.
-   /// \retval NULL \ERROR_HAS_OCCURRED
+   /// \retval !="" The json.
+   /// \retval "" \ERROR_HAS_OCCURRED
    /// \TO_DETERMINE_STATUS_CODE{BtrieveSpace::GetLastStatusCode}
-   const char *DotProductSimilarity(const char *vector, int limit, const char *query = NULL);
+   std::string DotProductSimilarity(const char *vector, int limit, const char *query = NULL);
 
 private:
    BtrieveClient *btrieveClient = NULL;
    BtrieveFile *btrieveFile = NULL;
    Btrieve::StatusCode lastStatusCode = Btrieve::STATUS_CODE_NO_ERROR;
    int vectorLength = 0;
-   const char *ProcessSimilarity(const char *vector, int limit, const char *query,
-        Btrieve::StatusCode (BtrieveBulkRetrieveAttributes::*addSimilarity)(const char *, int, int), 
-        const char *similarityKey);
+   std::string ProcessSimilarity(const char *vector, int limit, const char *query, 
+      Btrieve::StatusCode (BtrieveBulkRetrieveAttributes::*addSimilarity)(const char *, int, int), const char *similarityKey);
+   Btrieve::StatusCode VectorRetrieveHelper(struct btrieveVector *btrieveVector, std::string *json = NULL, 
+      char *blob = NULL, int blobSize = 0, int vectorBlobOffset = 0, int vectorBlobLength = 0);
+   Btrieve::StatusCode VectorRetrieve(int id, std::string *json = NULL, char *blob = NULL, 
+      int blobSize = 0, int vectorBlobOffset = 0, int vectorBlobLength = 0);
+   Btrieve::StatusCode VectorRetrieve(const char *uuid, std::string *json = NULL, char *blob = NULL, int blobSize = 0, int vectorBlobOffset = 0, int vectorBlobLength = 0);
 };
 
 /// \brief The %Btrieve vector set class.