Working with the Eventing Service in Couchbase Cloud


    This is the fourth tutorial in the series of “First Timer” tutorials. By following the steps in order, you will use the Couchbase Cloud Eventing Service to automate actions based on changes to data.

    The Couchbase Eventing Service is a framework to automate operations based on changes to data in real time. “Events” are triggered by changes to data (known as “mutations”) in the Couchbase Cloud cluster. The Couchbase Cloud cluster considers create, update, expiry, or delete operations as a data mutation. Natively integrated with Couchbase Cloud, the Eventing Service does not require any third party solutions to manage and respond to data mutations. In an event-based architecture, all data changes are reacted to in real-time.

    Use Case: Eventing for Data Enrichment

    In this simple example we will show you how to enrich data with new searchable attributes by automatically adding them to the document. These new attributes are related to and can be calculated from the original attributes. On any mutation (a document creation or modification) the new attributes should automatically be created (or updated).

    Let’s set up the example!

    Setting up the example data buckets

    1. Log in to your Couchbase Cloud account, then click Clusters in the side navigation. Click your cluster name to display the cluster Overview screen then click the Buckets tab.

      Click the buckets tab on your cluster’s Overview screen
    2. Click the Add Bucket button. The Add Bucket fly out appears.

      For this example, two buckets, source and metadata, are required. (Note that the metadata bucket for Eventing can be shared with other Eventing functions).

      Create the source bucket with the default minimum size of 100 MB and click Save.

      Repeat the step for the metadata bucket.

      Create two buckets

      You now have 2 new buckets: source and metadata.

      The two buckets
      The metadata bucket is for the sole use of the Eventing service. Do not add, modify, or delete documents from this bucket. In addition do not drop, flush, or delete the bucket while you have any deployed Eventing functions.
    3. Now let’s add some data to the source bucket. In the cluster Tools menu, select Documents.

      Add some data to the source bucket
    4. In the Bucket dropdown menu, select source.

      Select source from the bucket drop-down menu
    5. Click the Add Document button. The Add Document fly out appears.

    6. We will give our document a simple ID. Under Document ID enter SampleDocument.

    7. Copy the following code and paste it into the code window:

      "country": "AD",
        "ip_start": "",
        "ip_end": ""
      Copy the code into the code window

      Click Save.

    8. Repeat the steps for another document in the source bucket:

      Under Document ID enter AnotherSampleDocument.

      Copy and paste the following code into the code window:

        "country": "RU",
        "ip_start": "",
        "ip_end": ""

      Click Save.

      You should now see two documents in the source bucket, each with simple IP address data.

      There are two documents in the source bucket
    9. Now we will create our Eventing function. In the cluster Tools menu, select Eventing.

      Create an Eventing function

      The Eventing screen appears.

      The Eventing screen is displayed
    10. Click the Add Function button. The Add New Function fly out appears.

      The Add New Functions fly out is displayed

      We will create a JavaScript function that contains an OnUpdate handler. The handler listens for data changes within a specified source bucket. When any document within the bucket is created or modified, the handler executes a user-defined routine.

      In this example, if any created or altered document contains two specifically named fields containing IP addresses (these respectively corresponding to the beginning and end of an address-range), the handler-routine converts each of the IP addresses to an integer and upserts them as new fields in the document.

    11. In the ADD FUNCTION dialog, for individual Function elements provide the below information:

      • enrich_ips : Enter the name of the Function you are creating in the Function Name text-box.

      • Source Bucket drop-down: Select source. *Metqdata Bucket drop-down: Select metadata.

      • Settings: Use the default values.

      • Bindings: Click Add one binding. Under Bindings, click Add and add the following settings:

        • Bucket Alias: src

        • Bucket: source

        • Permission: read and write

          After configuring your settings your screen should look like:

          Configure your settings for individual function elements

          Click Save. The Javascript code window appears.

          Once you configure and save your settings
    12. Copy the following code and paste it to the Javascript code window (paste over the default text in the code window):

      function OnUpdate(doc, meta) {
        log('document', doc);
        doc["ip_num_start"] = get_numip_first_3_octets(doc["ip_start"]);
        doc["ip_num_end"]   = get_numip_first_3_octets(doc["ip_end"]);
        // !!! write back to the source bucket !!!
      function get_numip_first_3_octets(ip) {
        var return_val = 0;
        if (ip) {
          var parts = ip.split('.');
          //IP Number = A x (256*256*256) + B x (256*256) + C x 256 + D
          return_val = (parts[0]*(256*256*256)) + (parts[1]*(256*256)) + (parts[2]*256) + parseInt(parts[3]);
          return return_val;
      Copy the code provided and paste it to the Javascript code window

      The code will automatically create two new fields when it encounters the fields ip_start or ip_end.

      The new fields will be called ip_num_start and ip_num_end, and their values will be created by converting each of the IP addresses to an integer and upserting them as new fields in the document. The get_numip_first_3_octets routine splits the IP address, converts each fragment to a numeral, and adds the numerals together, to form a single value; which it returns.

      This effectively automates data mutation whenever a document is added or modified, adding new data to the document based on IP range data it contains.

      Click Save.

    13. In the Eventing screen, click the ellipsis next to the enrich_ips function and select Deploy.

      Deploy the enrich_ips function

      The Confirm Deploy Function fly out appears. Accept the default feed boundary of Everything (which means it will execute against any existing and future documents) and click Deploy.

      Confirm deploy function
    14. In the Eventing screen you will see the enrich_ip function has been deployed.

      The Eventing screen shows that the enrich_ip function has been deployed

      Now let’s see what changes to the data has been made by the function.

    15. In the cluster Tools menu select Documents.

    16. In the Documents screen under Buckets, select source. The two sample documents you created earlier are listed here.

      The two sample documents created earlier are available on the Documents screen

      Click SampleDocument to open the document for editing. You will see two new fields have been created by the Eventing function: ip_num_start and ip_num_end

      Two new fields have been created by the Eventing functions
    17. Optionally open the AnotherSampleDocument document to see its changes.

    18. Experiment! In either document, make a minor edit to the ip_start field by changing the IP address slightly. Once you save it, the ip_num_start field will update accordingly.

    Congratulations! You have just created and deployed an Eventing Function to your Couchbase Cloud cluster. The function automates the update of data based on changes in the document. Eventing can just as easily perform other useful functions like cascading deletes or calling external REST services for more advanced automatic responses to data changes.

    1. Once you are done with this example, it’s best practice to clean up the demo by undeploying the function and deleting the source and metadata buckets. In the Eventing menu, click on the ellipsis next to enrich_ip and select Undeploy.

      As a best practice

      Once it shows Undeployed, click the ellipsis next to the function and select Delete.

    2. Next, you can safely delete the source and metadata buckets.

    To learn more about the Eventing Service on Couchbase Cloud and try other examples, check out the documentation here.