Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

A newer version of this documentation is available.

View Latest

Sample Application

  • tutorial
    +
    Discover how to program interactions with the Couchbase Server via the data, query, and search services — using the Travel Sample Application with the built-in Travel Sample data Bucket. Discover how to program interactions with Couchbase Server 7.X via the Data, Query, and Search services — using the Travel Sample Application with the built-in Travel Sample data Bucket.

    Quick Start

    Fetch the Couchbase Scala SDK travel-sample Application REST Backend from github:

    git clone https://github.com/couchbaselabs/try-cb-scala.git
cd try-cb-scala

    With Docker installed, you should now be able to run a bare-bones copy of Couchbase Server, load the travel-sample, add indexes, install the sample-application and its frontend, all by running a single command:

    docker-compose --profile local up

    Running the code against your own development Couchbase server.

    For Couchbase Server 7.6, make sure that you have at least one node each of data; query; index; and search. For a development box, mixing more than one of these on a single node (given enough memory resources) is perfectly acceptable.

    If you have yet to install Couchbase Server in your development environment start here.

    Then load up the Travel Sample Bucket, using either the Web interface or the command line. You will also need to create a Search Index — Query indexes are taken care of by the Sample Bucket.

    See the README at https://github.com/couchbaselabs/try-cb-scala for full details of how to run and tweak the Scala SDK travel-sample app.

    Using the Sample App

    Travel Sample Register

    Give yourself a username and password and click Register.

    You can now try out searching for flights, booking flights, and searching for hotels. You can see which Couchbase SDK operations are being executed by clicking the red bar at the bottom of the screen:

    Couchbase Query Bar

    Sample App Backend

    The backend code shows Couchbase Scala SDK in action with Query and Search, but also how to plug together all of the elements and build an application with Couchbase Server and the Scala SDK.

    The app directory contains the various components, classes and functions for handling users, registration, and SQL++ (formerly N1QL) queries.

    Data Model

    See the Travel App Data Model reference page for more information about the sample data set used.

    REST API

    You can explore the REST API here in read-only mode, or once you are running the application, at the /apidocs endpoint.