PCBC-533: implement FTS index management APIs

Change-Id: Id3b5c2059a10bcfa7916577096479eca98290917
Reviewed-on: http://review.couchbase.org/97929
Tested-by: Build Bot <[email protected]>
Reviewed-by: Sergey Avseyev <[email protected]>

Author: avsej

config.m4

@@ -126,6 +126,7 @@ COUCHBASE_FILES=" \
     src/couchbase/view_query_encodable.c \
     src/couchbase/spatial_view_query.c \
     transcoding.c \
+    src/couchbase/search_index_manager.c \
 "
 
   AC_CHECK_HEADERS([zlib.h])

config.w32

@@ -45,6 +45,7 @@ if (PHP_COUCHBASE != "no") {
             "n1ql_index.c " +
             "n1ql_query.c " +
             "pool.c " +
+            "search_index_manager.c " +
             "search_query.c " +
             "spatial_view_query.c " +
             "view_query.c " +

couchbase.c

@@ -319,6 +319,7 @@ PHP_MINIT_FUNCTION(couchbase)
     PHP_MINIT(SearchSortId)(INIT_FUNC_ARGS_PASSTHRU);
     PHP_MINIT(SearchSortScore)(INIT_FUNC_ARGS_PASSTHRU);
     PHP_MINIT(CryptoProvider)(INIT_FUNC_ARGS_PASSTHRU);
+    PHP_MINIT(SearchIndexManager)(INIT_FUNC_ARGS_PASSTHRU);
 
     PCBC_REGISTER_CONST(PERSISTTO_MASTER);
     PCBC_REGISTER_CONST(PERSISTTO_ONE);

couchbase.h

@@ -174,6 +174,7 @@ PHP_MINIT_FUNCTION(SearchSortGeoDistance);
 PHP_MINIT_FUNCTION(SearchSortId);
 PHP_MINIT_FUNCTION(SearchSortScore);
 PHP_MINIT_FUNCTION(CryptoProvider);
+PHP_MINIT_FUNCTION(SearchIndexManager);
 
 zval *bop_get_return_doc(zval *return_value, const char *key, int key_len, int is_mapped TSRMLS_DC);
 
@@ -496,6 +497,12 @@ typedef struct {
     PCBC_ZEND_OBJECT_POST
 } pcbc_cluster_manager_t;
 
+typedef struct {
+    PCBC_ZEND_OBJECT_PRE
+    pcbc_connection_t *conn;
+    PCBC_ZEND_OBJECT_POST
+} pcbc_search_index_manager_t;
+
 struct pcbc_crypto_id {
     char *name;
     int name_len;
@@ -825,6 +832,7 @@ void pcbc_bucket_view_request(pcbc_bucket_t *bucket, lcb_CMDVIEWQUERY *cmd, int
                               zval *return_value TSRMLS_DC);
 void pcbc_spatial_view_query_init(zval *return_value, char *design_document, int design_document_len, char *view_name,
                                   int view_name_len TSRMLS_DC);
+void pcbc_search_index_manager_init(zval *return_value, pcbc_bucket_manager_t *bucket_manager TSRMLS_DC);
 
 void pcbc_boolean_field_search_query_init(zval *return_value, zend_bool value TSRMLS_DC);
 void pcbc_boolean_search_query_init(zval *return_value TSRMLS_DC);
@@ -851,7 +859,8 @@ void pcbc_numeric_range_search_facet_init(zval *return_value, char *field, int f
 void pcbc_search_sort_id_init(zval *return_value TSRMLS_DC);
 void pcbc_search_sort_score_init(zval *return_value TSRMLS_DC);
 void pcbc_search_sort_field_init(zval *return_value, const char *field, int field_len TSRMLS_DC);
-void pcbc_search_sort_geo_distance_init(zval *return_value, const char *field, int field_len, double lon, double lat TSRMLS_DC);
+void pcbc_search_sort_geo_distance_init(zval *return_value, const char *field, int field_len, double lon,
+                                        double lat TSRMLS_DC);
 
 #if PHP_VERSION_ID >= 70000
 void pcbc_lookup_in_builder_init(zval *return_value, zval *bucket, const char *id, int id_len, zval *args,
@@ -877,8 +886,10 @@ void pcbc_password_authenticator_init(zval *return_value, char *username, int us
 
 void pcbc_crypto_register(pcbc_bucket_t *obj, const char *name, int name_len, zval *provider TSRMLS_DC);
 void pcbc_crypto_unregister(pcbc_bucket_t *obj, const char *name, int name_len TSRMLS_DC);
-void pcbc_crypto_encrypt_fields(pcbc_bucket_t *obj, zval *document, zval *options, const char *prefix, zval *return_value TSRMLS_DC);
-void pcbc_crypto_decrypt_fields(pcbc_bucket_t *obj, zval *document, zval *options, const char *prefix, zval *return_value TSRMLS_DC);
+void pcbc_crypto_encrypt_fields(pcbc_bucket_t *obj, zval *document, zval *options, const char *prefix,
+                                zval *return_value TSRMLS_DC);
+void pcbc_crypto_decrypt_fields(pcbc_bucket_t *obj, zval *document, zval *options, const char *prefix,
+                                zval *return_value TSRMLS_DC);
 
 #if PHP_VERSION_ID >= 70000
 static inline pcbc_cluster_t *pcbc_cluster_fetch_object(zend_object *obj)
@@ -945,6 +956,10 @@ static inline pcbc_user_settings_t *pcbc_user_settings_fetch_object(zend_object
 {
     return (pcbc_user_settings_t *)((char *)obj - XtOffsetOf(pcbc_user_settings_t, std));
 }
+static inline pcbc_search_index_manager_t *pcbc_search_index_manager_fetch_object(zend_object *obj)
+{
+    return (pcbc_search_index_manager_t *)((char *)obj - XtOffsetOf(pcbc_search_index_manager_t, std));
+}
 #define Z_CLUSTER_OBJ(zo) (pcbc_cluster_fetch_object(zo))
 #define Z_CLUSTER_OBJ_P(zv) (pcbc_cluster_fetch_object(Z_OBJ_P(zv)))
 #define Z_CLUSTER_MANAGER_OBJ(zo) (pcbc_cluster_manager_fetch_object(zo))
@@ -977,6 +992,8 @@ static inline pcbc_user_settings_t *pcbc_user_settings_fetch_object(zend_object
 #define Z_CERT_AUTHENTICATOR_OBJ_P(zv) (pcbc_cert_authenticator_fetch_object(Z_OBJ_P(zv)))
 #define Z_USER_SETTINGS_OBJ(zo) (pcbc_user_settings_fetch_object(zo))
 #define Z_USER_SETTINGS_OBJ_P(zv) (pcbc_user_settings_fetch_object(Z_OBJ_P(zv)))
+#define Z_SEARCH_INDEX_MANAGER_OBJ(zo) (pcbc_search_index_manager_fetch_object(zo))
+#define Z_SEARCH_INDEX_MANAGER_OBJ_P(zv) (pcbc_search_index_manager_fetch_object(Z_OBJ_P(zv)))
 #else
 #define Z_CLUSTER_OBJ(zo) ((pcbc_cluster_t *)zo)
 #define Z_CLUSTER_OBJ_P(zv) ((pcbc_cluster_t *)zend_object_store_get_object(zv TSRMLS_CC))
@@ -1010,6 +1027,8 @@ static inline pcbc_user_settings_t *pcbc_user_settings_fetch_object(zend_object
 #define Z_CERT_AUTHENTICATOR_OBJ_P(zv) ((pcbc_cert_authenticator_t *)zend_object_store_get_object(zv TSRMLS_CC))
 #define Z_USER_SETTINGS_OBJ(zo) ((pcbc_user_settings_t *)zo)
 #define Z_USER_SETTINGS_OBJ_P(zv) ((pcbc_user_settings_t *)zend_object_store_get_object(zv TSRMLS_CC))
+#define Z_SEARCH_INDEX_MANAGER_OBJ(zo) ((pcbc_search_index_manager_t *)zo)
+#define Z_SEARCH_INDEX_MANAGER_OBJ_P(zv) ((pcbc_search_index_manager_t *)zend_object_store_get_object(zv TSRMLS_CC))
 #endif
 
 typedef struct {

examples/search/index_management.php

@@ -0,0 +1,52 @@
+<?php
+
+$cluster = new \Couchbase\Cluster('couchbase://localhost');
+$cluster->authenticateAs('Administrator', 'password');
+
+$bucket = $cluster->openBucket('travel-sample');
+
+$manager = $bucket->manager()->searchIndexManager();
+
+var_dump($manager->listIndexDefinitions());
+
+var_dump($manager->getIndexDefinition('travel-sample-index-hotel-description'));
+
+var_dump($manager->getIndexedDocumentsCount('travel-sample-index-hotel-description'));
+
+$indexDef = '
+{
+  "type": "fulltext-index",
+  "name": "testindex",
+  "sourceType": "couchbase",
+  "sourceName": "travel-sample",
+  "planParams": {
+    "maxPartitionsPerPIndex": 171
+  },
+  "params": {
+    "doc_config": {
+      "mode": "type_field",
+      "type_field": "type"
+    },
+    "mapping": {
+      "default_analyzer": "standard",
+      "default_datetime_parser": "dateTimeOptional",
+      "default_field": "_all",
+      "default_mapping": {
+        "dynamic": true,
+        "enabled": true
+      },
+      "default_type": "_default",
+      "index_dynamic": true,
+      "store_dynamic": false
+    },
+    "store": {
+      "kvStoreName": "mossStore"
+    }
+  },
+  "sourceParams": {}
+}
+';
+
+var_dump($manager->createIndex('testindex', $indexDef));
+
+var_dump($manager->deleteIndex('testindex'));

src/couchbase/bucket_manager.c

@@ -425,6 +425,20 @@ PHP_METHOD(BucketManager, dropN1qlIndex)
     pcbc_n1ix_drop(obj, &cmd, ignore_if_not_exist, return_value TSRMLS_CC);
 } /* }}} */
 
+/* {{{ proto \Couchbase\SearchIndexManager Cluster::searchIndexManager() */
+PHP_METHOD(BucketManager, searchIndexManager)
+{
+    pcbc_bucket_manager_t *obj;
+    int rv;
+
+    rv = zend_parse_parameters_none();
+    if (rv == FAILURE) {
+        RETURN_NULL();
+    }
+    obj = Z_BUCKET_MANAGER_OBJ_P(getThis());
+    pcbc_search_index_manager_init(return_value, obj TSRMLS_CC);
+} /* }}} */
+
 ZEND_BEGIN_ARG_INFO_EX(ai_BucketManager_none, 0, 0, 0)
 ZEND_END_ARG_INFO()
 
@@ -479,6 +493,7 @@ zend_function_entry bucket_manager_methods[] = {
     PHP_ME(BucketManager, createN1qlIndex, ai_BucketManager_createN1qlIndex, ZEND_ACC_PUBLIC)
     PHP_ME(BucketManager, dropN1qlPrimaryIndex, ai_BucketManager_dropN1qlPrimaryIndex, ZEND_ACC_PUBLIC)
     PHP_ME(BucketManager, dropN1qlIndex, ai_BucketManager_dropN1qlIndex, ZEND_ACC_PUBLIC)
+    PHP_ME(BucketManager, searchIndexManager, ai_BucketManager_none, ZEND_ACC_PUBLIC)
     PHP_FE_END
 };
 // clang-format on

src/couchbase/cluster_manager.c

@@ -268,7 +268,8 @@ PHP_METHOD(ClusterManager, removeUser)
     }
 } /* }}} */
 
-/* {{{ proto array ClusterManager::upsertUser(string $name, \Couchbase\UserSettings $settings, $domain = ClusterManager::RBAC_DOMAIN_LOCAL) */
+/* {{{ proto array ClusterManager::upsertUser(string $name, \Couchbase\UserSettings $settings, $domain =
+ * ClusterManager::RBAC_DOMAIN_LOCAL) */
 PHP_METHOD(ClusterManager, upsertUser)
 {
     pcbc_cluster_manager_t *obj;
@@ -285,7 +286,8 @@ PHP_METHOD(ClusterManager, upsertUser)
 
     obj = Z_CLUSTER_MANAGER_OBJ_P(getThis());
 
-    rv = zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sO|l", &name, &name_len, &settings, pcbc_user_settings_ce, &domain);
+    rv = zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sO|l", &name, &name_len, &settings, pcbc_user_settings_ce,
+                               &domain);
     if (rv == FAILURE) {
         return;
     }
@@ -373,7 +375,6 @@ ZEND_BEGIN_ARG_INFO_EX(ai_ClusterManager_listUsers, 0, 0, 1)
 ZEND_ARG_INFO(0, domain)
 ZEND_END_ARG_INFO()
 
-
 // clang-format off
 zend_function_entry cluster_manager_methods[] = {
     PHP_ME(ClusterManager, __construct, ai_ClusterManager_none, ZEND_ACC_PRIVATE | ZEND_ACC_FINAL | ZEND_ACC_CTOR)