mt-libcouchbase 1.4.0

data/ext/libcouchbase/example/CMakeLists.txt

@@ -0,0 +1,52 @@
+# This builds the examples; all these targets are optional
+SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/examples")
+
+MACRO(ADD_EXAMPLE name dir linkspec incspec)
+    SET(dir "${CMAKE_CURRENT_SOURCE_DIR}/${dir}")
+    FILE(GLOB _cur_src ${dir}/*.cc ${dir}/*.c ${dir}/*.cpp)
+    ADD_EXECUTABLE(${name} ${_cur_src})
+    TARGET_LINK_LIBRARIES(${name} couchbase ${linkspec})
+
+    GET_TARGET_PROPERTY(_tmp_inc ${name} INCLUDE_DIRECTORIES)
+    LIST(APPEND ${_tmp_inc} ${dir} ${incspec})
+    SET_TARGET_PROPERTIES(${name} PROPERTIES INCLUDE_DIRECTORIES "${_tmp_inc}")
+ENDMACRO()
+
+# ADD_EXAMPLE(db db "" "")
+ADD_EXECUTABLE(db db/db.c)
+ADD_EXECUTABLE(vb db/vb.c)
+TARGET_LINK_LIBRARIES(db couchbase)
+TARGET_LINK_LIBRARIES(vb couchbase)
+
+ADD_EXAMPLE(mcc mcc "" "")
+ADD_EXAMPLE(views-example views "" "")
+ADD_EXAMPLE(tick tick "" "")
+ADD_EXAMPLE(users users "" "")
+ADD_EXAMPLE(fts fts "" "")
+ADD_EXAMPLE(analytics analytics "" "")
+
+ADD_EXECUTABLE(subdoc-simple subdoc/subdoc-simple.cc)
+ADD_EXECUTABLE(subdoc-multi subdoc/subdoc-multi.cc)
+ADD_EXECUTABLE(subdoc-xattrs subdoc/subdoc-xattrs.c)
+TARGET_LINK_LIBRARIES(subdoc-simple couchbase)
+TARGET_LINK_LIBRARIES(subdoc-multi couchbase)
+TARGET_LINK_LIBRARIES(subdoc-xattrs couchbase)
+
+ADD_EXECUTABLE(minimal minimal/minimal.c)
+TARGET_LINK_LIBRARIES(minimal couchbase)
+
+ADD_EXECUTABLE(query minimal/query.c)
+TARGET_LINK_LIBRARIES(query couchbase)
+
+ADD_EXECUTABLE(observe observe/observe.c)
+TARGET_LINK_LIBRARIES(observe couchbase)
+
+ADD_EXECUTABLE(durability observe/durability.c)
+TARGET_LINK_LIBRARIES(durability couchbase)
+
+IF(NOT WIN32)
+    ADD_EXAMPLE(instancepool instancepool pthread "")
+ENDIF()
+IF(HAVE_LIBEVENT2)
+    ADD_EXAMPLE(libevent-direct libeventdirect ${LIBEVENT_LIBRARIES} ${LIBEVENT_INCLUDE_DIR})
+ENDIF()

data/ext/libcouchbase/example/README.markdown

@@ -0,0 +1,47 @@
+Examples
+========
+
+An example says more than a 1000 words (and its way easier to write an
+example than trying to explain something). In this directory you'll
+find a varity of examples that will show you different use patterns of
+libcoucbase.
+
+libeventdirect
+--------------
+
+This example programs shows you how you may integrate libcouchbase
+into your own event loop (in this example libevent).
+
+syncmode
+--------
+
+This example shows you how you may use the synchronous interface of
+libcouchbase.
+
+yajl
+----
+
+This is an example that shows you how to work with views and json
+
+pillowfight
+-----------
+
+This is an example that implements a small test program to show
+you some of the functionalities in libcouchbase.
+
+minimal
+-------
+
+This is an minimal single-file example which works both unix-like and windows OS.
+It accepts three arguments: "host:port", "bucket" and "password".
+
+Build:
+
+     gcc -lcouchbase -o minimal minimal.c
+     cl /DWIN32 /Iinclude lib\libcouchbase.lib minimal.c
+
+Execute:
+
+     valgrind -v --tool=memcheck  --leak-check=full --show-reachable=yes ./minimal
+     ./minimal <host:port> <bucket> <passwd>
+     mininal.exe <host:port> <bucket> <passwd>

data/ext/libcouchbase/example/analytics/.gitignore

@@ -0,0 +1 @@
+analytics

data/ext/libcouchbase/example/analytics/analytics.c

@@ -0,0 +1,158 @@
+/* -*- Mode: C; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *     Copyright 2018 Couchbase, Inc.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+/**
+
+   CFLAGS="-I$(realpath ../../include) -I$(realpath ../../build/generated)"
+   LDFLAGS="-L$(realpath ../../build/lib) -lcouchbase -Wl,-rpath=$(realpath ../../build/lib)"
+   make analytics
+
+ */
+
+#include <unistd.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+#include <libcouchbase/couchbase.h>
+#include <libcouchbase/n1ql.h>
+
+#include "queries.h"
+#include "cJSON.h"
+
+static void fail(const char *msg)
+{
+    printf("[\x1b[31mERROR\x1b[0m] %s\n", msg);
+    exit(EXIT_FAILURE);
+}
+
+static void check(lcb_error_t err, const char *msg)
+{
+    if (err != LCB_SUCCESS) {
+        char buf[1024] = {0};
+        snprintf(buf, sizeof(buf), "%s: %s\n", msg, lcb_strerror_short(err));
+        fail(buf);
+    }
+}
+
+static int err2color(lcb_error_t err)
+{
+    switch (err) {
+        case LCB_SUCCESS:
+            return 49;
+        default:
+            return 31;
+    }
+}
+
+static void row_callback(lcb_t instance, int type, const lcb_RESPN1QL *resp)
+{
+    int *idx = (int *)resp->cookie;
+    if (resp->rc != LCB_SUCCESS) {
+        printf("\x1b[31m%s\x1b[0m", lcb_strerror_short(resp->rc));
+        if (resp->htresp) {
+            printf(", HTTP status: %d", resp->htresp->htstatus);
+        }
+        printf("\n");
+        if (resp->nrow) {
+            cJSON *json;
+            char *data = calloc(resp->nrow + 1, sizeof(char));
+            memcpy(data, resp->row, resp->nrow);
+            json = cJSON_Parse(data);
+            if (json && json->type == cJSON_Object) {
+                cJSON *errors = cJSON_GetObjectItem(json, "errors");
+                if (errors && errors->type == cJSON_Array) {
+                    int ii, nerrors = cJSON_GetArraySize(errors);
+                    for (ii = 0; ii < nerrors; ii++) {
+                        cJSON *err = cJSON_GetArrayItem(errors, ii);
+                        if (err && err->type == cJSON_Object) {
+                            cJSON *code, *msg;
+                            code = cJSON_GetObjectItem(err, "code");
+                            msg = cJSON_GetObjectItem(err, "msg");
+                            if (code && code->type == cJSON_Number && msg && msg->type == cJSON_String) {
+                                printf(
+                                    "\x1b[1mcode\x1b[0m: \x1b[31m%d\x1b[0m, \x1b[1mmessage\x1b[0m: \x1b[31m%s\x1b[0m\n",
+                                    code->valueint, msg->valuestring);
+                            }
+                        }
+                    }
+                }
+            }
+            free(data);
+        }
+    }
+    if (resp->rflags & LCB_RESP_F_FINAL) {
+        printf("\x1b[1mMETA:\x1b[0m ");
+    } else {
+        printf("\x1b[1mR%d:\x1b[0m ", (*idx)++);
+    }
+    printf("%.*s\n", (int)resp->nrow, (char *)resp->row);
+    if (resp->rflags & LCB_RESP_F_FINAL) {
+        printf("\n");
+    }
+}
+
+int main(int argc, char *argv[])
+{
+    lcb_error_t err;
+    lcb_t instance;
+    char *bucket = NULL;
+    size_t ii;
+
+    if (argc < 2) {
+        printf("Usage: %s couchbase://host/beer-sample [ password [ username ] ]\n", argv[0]);
+        exit(EXIT_FAILURE);
+    }
+
+    {
+        struct lcb_create_st create_options = {0};
+        create_options.version = 3;
+        create_options.v.v3.connstr = argv[1];
+        if (argc > 2) {
+            create_options.v.v3.passwd = argv[2];
+        }
+        if (argc > 3) {
+            create_options.v.v3.username = argv[3];
+        }
+        check(lcb_create(&instance, &create_options), "create couchbase handle");
+        check(lcb_connect(instance), "schedule connection");
+        lcb_wait(instance);
+        check(lcb_get_bootstrap_status(instance), "bootstrap from cluster");
+        check(lcb_cntl(instance, LCB_CNTL_GET, LCB_CNTL_BUCKETNAME, &bucket), "get bucket name");
+        if (strcmp(bucket, "beer-sample") != 0) {
+            fail("expected bucket to be \"beer-sample\"");
+        }
+    }
+
+    for (ii = 0; ii < num_queries; ii++) {
+        lcb_CMDN1QL cmd = {0};
+        int idx = 0;
+        /* NOTE: with this flag, the request will be issued to Analytics service */
+        cmd.cmdflags = LCB_CMDN1QL_F_ANALYTICSQUERY;
+        cmd.callback = row_callback;
+        cmd.query = queries[ii].query;
+        cmd.nquery = queries[ii].query_len;
+        check(lcb_n1ql_query(instance, &idx, &cmd), "schedule analytics query");
+        printf("----> \x1b[1m%s\x1b[0m\n", queries[ii].comment);
+        printf("----> \x1b[36m%.*s\x1b[0m\n", (int)queries[ii].query_len, queries[ii].query);
+        lcb_wait(instance);
+    }
+
+    /* Now that we're all done, close down the connection handle */
+    lcb_destroy(instance);
+    return 0;
+}

data/ext/libcouchbase/example/analytics/build-queries.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/ruby
+
+#    Copyright 2018 Couchbase, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+require 'json'
+
+paths = Dir[File.join(__dir__, 'queries', '*.json')].sort
+File.open(File.join(__dir__, 'queries.h'), 'w+') do |out|
+  out.puts("// This file was generated by queries.rb")
+  out.puts("typedef struct analytics_query_str { const char *comment; size_t query_len; const char *query; } analytics_query_str;")
+  out.puts("size_t num_queries = #{paths.size};")
+  out.puts("analytics_query_str queries[#{paths.size + 1}] = {")
+  paths.each do |path|
+    lines = File.readlines(path)
+    lines.delete_at(0)
+    comment, query = lines.partition { |line| line.start_with?('//') }
+    comment_str = comment.map { |line| line.sub(%r(^//\s*), '').strip }.join(' ')
+    query_str = JSON.generate(JSON.parse(query.join.strip))
+    out.puts("{#{comment_str.inspect},\n #{query_str.size},\n #{query_str.inspect}},\n\n")
+  end
+  out.puts("{NULL, 0, NULL}};")
+end

data/ext/libcouchbase/example/analytics/cJSON.c

@@ -0,0 +1 @@
+../../contrib/cJSON/cJSON.c

data/ext/libcouchbase/example/analytics/cJSON.h

@@ -0,0 +1 @@
+../../contrib/cJSON/cJSON.h

data/ext/libcouchbase/example/analytics/queries/00-show-dataverse.json

@@ -0,0 +1,5 @@
+// vim: ft=javascript
+// Display dataverses defined by Analytics service
+{
+  "statement": "SELECT * FROM Metadata.`Dataverse`"
+}

data/ext/libcouchbase/example/analytics/queries/01-setup-dataset-breweries.json

@@ -0,0 +1,6 @@
+// vim: ft=javascript
+// Tell analytics service to shadow the data from beer-sample bucket using
+// breweries dataset.
+{
+  "statement": "CREATE DATASET breweries ON `beer-sample` WHERE `type` = \"brewery\""
+}

data/ext/libcouchbase/example/analytics/queries/02-setup-dataset-beers.json

@@ -0,0 +1,6 @@
+// vim: ft=javascript
+// Tell analytics service to shadow the data from beer-sample bucket using
+// beers dataset.
+{
+  "statement": "CREATE DATASET beers ON `beer-sample` WHERE `type` = \"beer\""
+}

data/ext/libcouchbase/example/analytics/queries/03-initiate-shadow.json

@@ -0,0 +1,6 @@
+// vim: ft=javascript
+// Initiate the shadowing relationship of datasets to the data in Couchbase
+// Server
+{
+  "statement": "CONNECT LINK Local"
+}

data/ext/libcouchbase/example/analytics/queries/04-list-datasets.json

@@ -0,0 +1,7 @@
+// vim: ft=javascript
+// List populated datasets
+{
+  "statement": "SELECT ds.BucketName, ds.DatasetName, ds.`Filter` FROM Metadata.`Dataset` ds WHERE ds.DataverseName = \"Default\""
+}
+
+

data/ext/libcouchbase/example/analytics/queries/05-count-breweries.json

@@ -0,0 +1,5 @@
+// vim: ft=javascript
+// Ask Analytics the number of breweries
+{
+  "statement": "SELECT VALUE COUNT(*) FROM breweries"
+}

data/ext/libcouchbase/example/analytics/queries/06-first-brewery.json

@@ -0,0 +1,6 @@
+// vim: ft=javascript
+// Retrieve first brewery, ordered by name
+{
+  "statement": "SELECT * FROM breweries ORDER BY name LIMIT 1",
+  "pretty": true
+}

data/ext/libcouchbase/example/analytics/queries/07-key-based-lookup.json

@@ -0,0 +1,6 @@
+// vim: ft=javascript
+// Find a particular brewery based on its Couchbase Server key
+{
+  "statement": "SELECT meta(bw) AS meta, bw AS data FROM breweries bw WHERE meta(bw).id = 'kona_brewing'",
+  "pretty": true
+}

data/ext/libcouchbase/example/analytics/queries/08-exact-match-lookup.json

@@ -0,0 +1,7 @@
+// vim: ft=javascript
+// Find the same brewery information but in a slightly simpler or cleaner way
+// based only on the data
+{
+  "statement": "SELECT VALUE bw FROM breweries bw WHERE bw.name = 'Kona Brewing'",
+  "pretty": true
+}

data/ext/libcouchbase/example/analytics/queries/09-exact-match-lookup-different-shape.json

@@ -0,0 +1,6 @@
+// vim: ft=javascript
+// Find brewery by name, but return objects instead of values
+{
+  "statement": "SELECT bw FROM breweries bw WHERE bw.name = 'Kona Brewing'",
+  "pretty": true
+}

data/ext/libcouchbase/example/analytics/queries/10-other-query-filters.json

@@ -0,0 +1,6 @@
+// vim: ft=javascript
+// Apply a range condition together with a string condition to select breweries
+{
+  "statement": "SELECT VALUE bw FROM breweries bw WHERE bw.geo.lat > 60.0 AND bw.name LIKE '%Brewing%' ORDER BY bw.name",
+  "pretty": true
+}

data/ext/libcouchbase/example/analytics/queries/11-equijoin.json

@@ -0,0 +1,9 @@
+// vim: ft=javascript
+// Fetch  list of all breweries paired with their associated beers, with the
+// list enumerating the brewery name and the beer name for each such pair,
+// while also limiting the answer set size to at most 3 results.
+{
+  "statement": "SELECT bw.name AS brewer, br.name AS beer FROM breweries bw, beers br WHERE br.brewery_id = meta(bw).id ORDER BY bw.name, br.name LIMIT 3"
+}
+
+

data/ext/libcouchbase/example/analytics/queries/12-equijoin-select-star.json

@@ -0,0 +1,10 @@
+// vim: ft=javascript
+// Fetch  list of all breweries paired with their associated beers, including
+// all attributes, while also limiting the answer set size to at most 3
+// results.
+{
+  "statement": "SELECT * FROM breweries bw, beers br WHERE br.brewery_id = meta(bw).id ORDER BY bw.name, br.name LIMIT 3",
+  "pretty": true
+}
+
+

data/ext/libcouchbase/example/analytics/queries/13-ansi-join.json

@@ -0,0 +1,8 @@
+// vim: ft=javascript
+// Fetch  list of all breweries paired with their associated beers, including
+// all attributes, while also limiting the answer set size to at most 3
+// results. With ANSI JOINS!
+{
+  "statement": "SELECT * FROM breweries bw JOIN beers br ON br.brewery_id = meta(bw).id ORDER BY bw.name, br.name LIMIT 3",
+  "pretty": true
+}

data/ext/libcouchbase/example/analytics/queries/14-join-select-values.json

@@ -0,0 +1,8 @@
+// vim: ft=javascript
+// Fetch  list of all breweries paired with their associated beers, including
+// all attributes, while also limiting the answer set size to at most 3
+// results. Select values explicitly.
+{
+  "statement": "SELECT VALUE {\"bw\": bw, \"br\": br} FROM breweries bw, beers br WHERE br.brewery_id = meta(bw).id ORDER BY bw.name, br.name LIMIT 3",
+  "pretty": true
+}

data/ext/libcouchbase/example/analytics/queries/15-nested-outer-join.json

@@ -0,0 +1,7 @@
+// vim: ft=javascript
+// For each brewery produce an object that contains the brewery name along with
+// a list of all of the brewery’s offered beer names and alcohol percentages
+{
+  "statement": "SELECT bw.name AS brewer, (SELECT br.name, br.abv FROM beers br WHERE br.brewery_id = meta(bw).id ORDER BY br.name) AS beers FROM breweries bw ORDER BY bw.name LIMIT 2",
+  "pretty": true
+}

data/ext/libcouchbase/example/analytics/queries/16-theta-join.json

@@ -0,0 +1,8 @@
+// vim: ft=javascript
+// For each Arizona brewery get the brewery's name, location, and a list of
+// competitors' names -- where competitors are other breweries that are
+// geographically close to their location
+{
+  "statement": "SELECT bw1.name AS brewer, bw1.geo AS location, (SELECT VALUE bw2.name FROM breweries bw2 WHERE bw2.name != bw1.name AND abs(bw1.geo.lat - bw2.geo.lat) <= 0.1 AND abs(bw2.geo.lon - bw1.geo.lon) <= 0.1) AS competitors FROM breweries bw1 WHERE bw1.state = 'Arizona' ORDER BY bw1.name LIMIT 3",
+  "pretty": true
+}

data/ext/libcouchbase/example/analytics/queries/17-existential-quantification.json

@@ -0,0 +1,9 @@
+// vim: ft=javascript
+// Find those breweries whose beers include at least one IPA and return the
+// brewery’s name, phone number, and complete list of beer names and associated
+// alcohol levels.
+{
+  "statement": "WITH nested_breweries AS ( SELECT bw.name AS brewer, bw.phone, ( SELECT br.name, br.abv FROM beers br WHERE br.brewery_id = meta(bw).id ORDER BY br.name) AS beers FROM breweries bw) SELECT VALUE nb FROM nested_breweries nb WHERE (SOME b IN nb.beers SATISFIES b.name LIKE '%IPA%') ORDER BY nb.brewer LIMIT 2",
+  "pretty": true
+}
+

data/ext/libcouchbase/example/analytics/queries/18-universal-quantification.json

@@ -0,0 +1,7 @@
+// vim: ft=javascript
+// Find those breweries that only have seriously strong beers
+{
+  "statement": "WITH nested_breweries AS ( SELECT bw.name AS brewer, bw.phone, ( SELECT br.name, br.abv FROM beers br WHERE br.brewery_id = meta(bw).id ORDER BY br.name) AS beers FROM breweries bw) SELECT VALUE nb FROM nested_breweries nb WHERE (EVERY b IN nb.beers SATISFIES b.abv >= 10) AND ARRAY_COUNT(nb.beers) > 0 ORDER BY nb.brewer LIMIT 5",
+  "pretty": true
+}
+

data/ext/libcouchbase/example/analytics/queries/19-simple-aggregation.json

@@ -0,0 +1,6 @@
+// vim: ft=javascript
+// Compute the total number of beers in a SQL-like way
+{
+  "statement": "SELECT COUNT(*) AS num_beers FROM beers"
+}
+

data/ext/libcouchbase/example/analytics/queries/20-simple-aggregation-unwrapped-value.json

@@ -0,0 +1,6 @@
+// vim: ft=javascript
+// Compute the total number of beers and return unwrapped value
+{
+  "statement": "SELECT VALUE COUNT(b) FROM beers b"
+}
+

data/ext/libcouchbase/example/analytics/queries/21-simple-aggregation-explicit.json

@@ -0,0 +1,6 @@
+// vim: ft=javascript
+// Compute the total number of beers with explicit aggregate function
+{
+  "statement": "SELECT VALUE ARRAY_COUNT((SELECT b FROM beers b))"
+}
+

data/ext/libcouchbase/example/analytics/queries/22-grouping-and-aggregation.json

@@ -0,0 +1,6 @@
+// vim: ft=javascript
+// For each brewery that offers more than 30 beers, the following group-by or
+// aggregate query reports the number of beers that it offers
+{
+  "statement": "SELECT br.brewery_id, COUNT(*) AS num_beers FROM beers br GROUP BY br.brewery_id HAVING COUNT(*) > 30 ORDER BY COUNT(*) DESC"
+}

data/ext/libcouchbase/example/analytics/queries/23-grouping-and-aggregation-with-hint.json

@@ -0,0 +1,7 @@
+// vim: ft=javascript
+// For each brewery that offers more than 30 beers, the following group-by or
+// aggregate query reports the number of beers that it offers. With a
+// hash-based aggregation hint.
+{
+  "statement": "SELECT br.brewery_id, COUNT(*) AS num_beers FROM beers br /*+ hash */ GROUP BY br.brewery_id HAVING COUNT(*) > 30 ORDER BY COUNT(*) DESC"
+}

data/ext/libcouchbase/example/analytics/queries/24-grouping-and-limits.json

@@ -0,0 +1,7 @@
+// vim: ft=javascript
+// Return the top three breweries based on their numbers of offered beers. Also
+// illustrate the use of multiple aggregate functions to compute various
+// alcohol content statistics for their beers
+{
+  "statement": "SELECT bw.name, COUNT(*) AS num_beers, AVG(br.abv) AS abv_avg, MIN(br.abv) AS abv_min, MAX(br.abv) AS abv_max FROM breweries bw, beers br WHERE br.brewery_id = meta(bw).id GROUP BY bw.name ORDER BY num_beers DESC LIMIT 3"
+}

data/ext/libcouchbase/example/analytics/queries/25-named-parameters.json

@@ -0,0 +1,7 @@
+// vim: ft=javascript
+// Find the same brewery information but specify name as parameter
+{
+  "statement": "SELECT VALUE bw FROM breweries bw WHERE bw.name = $name",
+  "$name": "Kona Brewing",
+  "pretty": true
+}

data/ext/libcouchbase/example/analytics/queries/26-positional-parameters.json

@@ -0,0 +1,7 @@
+// vim: ft=javascript
+// Find the same brewery information but specify name as parameter
+{
+  "statement": "SELECT VALUE bw FROM breweries bw WHERE bw.name = ?",
+  "args": ["Kona Brewing"],
+  "pretty": true
+}