Couchbase GraphQL, REST and SQL++ Demo

Description

This demo application showcases how to manage an airline database using both GraphQL and REST interfaces. The application uses Flask for the web server and Couchbase for the database. It provides CRUD operations (Create, Read, Update, Delete) for managing airlines.

Steps to Setup and Run the Application

1. Create Docker Container

Run the following command to create and start a Couchbase container:

docker run -d --name cb_graphql_rest_demo -p 8091-8096:8091-8096 -p 11210-11211:11210-11211 -p 8501:8501 couchbase:7.6.1

2. Checkout Repository

Connect to the container:

docker exec -it cb_graphql_rest_demo /bin/bash

Go to:

cd /opt/

Install packages:

apt-get update
apt-get install git python3 python3-pip vim

Clone the repository inside the container:

git clone https://github.com/grbade/cb_graphql_rest_demo.git

3. Install Requirements

Go to:

cd /opt/cb_graphql_rest_demo/

Install the required Python packages using pip:

python3 -m pip install -r requirements.txt

Open your web browser and navigate to:

http://127.0.0.1:8091/

Create a couchbase cluster with:

username=Administrator
password=password

Install the "travel-sample" bucket https://docs.couchbase.com/server/current/manage/manage-settings/install-sample-buckets.html

Important

Before running the queries make sure that the bucket and indexes are added completely

4. Run Flask App

Start the Flask application:

python3 app.py

5. Go to GraphQL Playground

Open your web browser and navigate to:

http://127.0.0.1:8501/graphql

This will take you to the GraphQL Playground interface.

6. Test the GraphQL Queries

Sample GraphQL Queries

Get All Airlines

query {
  airlines {
    id
    type
    name
    iata
    icao
    callsign
    country
  }
}

Create an Airline

mutation {
  createAirline(id: 1234, type: "airline", name: "Sample Airline", iata: "SA", icao: "SAL", callsign: "SAMPLE", country: "USA") {
    success
    message
    airline {
      id
      type
      name
      iata
      icao
      callsign
      country
    }
  }
}

Get Airline by ID

query {
  airline(id: 1234) {
    id
    type
    name
    iata
    icao
    callsign
    country
  }
}

Get Airline by any field

query {
  airline(name: "Sample Airline", iata: "SA") {
    id
    type
    name
    iata
    icao
    callsign
    country
  }
}

Update an Airline

mutation {
  updateAirline(id: 1234, name: "Updated Airline") {
    success
    message
    airline {
      id
      type
      name
      iata
      icao
      callsign
      country
    }
  }
}

Delete an Airline

mutation {
  deleteAirline(id: 1234) {
    success
    message
  }
}

7. Test the REST Interface with cURL

Sample cURL Commands

Get All Airlines

curl -X GET http://127.0.0.1:8501/airlines

Create an Airline

curl -X POST http://127.0.0.1:8501/airline -H "Content-Type: application/json" -d '{
  "id": 1234,
  "type": "airline",
  "name": "Sample Airline",
  "iata": "SA",
  "icao": "SAL",
  "callsign": "SAMPLE",
  "country": "USA"
}'

Get Airline by ID

curl -X GET http://127.0.0.1:8501/airline?id=1234

Get Airline by any field

curl -G 'http://localhost:8501/airline?iata=SA&name=Sample+Airline'

Update an Airline

curl -X PUT http://127.0.0.1:8501/airline/1234 -H "Content-Type: application/json" -d '{
  "name": "Updated Airline"
}'

Delete an Airline

curl -X DELETE http://127.0.0.1:8501/airline/1234

8. SQL++ Queries

Sample SQL++ Queries

Get All Airlines:

SELECT * FROM `travel-sample`.inventory.airline WHERE type = 'airline';

Create Airline:

INSERT INTO `travel-sample`.inventory.airline (KEY, VALUE) VALUES ("airline_1234", {
  "id": "1234",
  "type": "airline",
  "name": "Sample Airline",
  "iata": "SA",
  "icao": "SAM",
  "callsign": "SAMPLE",
  "country": "USA"
});

Get Airline by ID

SELECT * FROM `travel-sample`.inventory.airline WHERE META().id = "airline_1234";

Get Airline by any field:

SELECT * FROM `travel-sample`.inventory.airline WHERE iata = 'SA' AND name = 'Sample Airline';

Update an Airline:

UPDATE `travel-sample`.inventory.airline SET 
  name = "Updated Airline" 
WHERE META().id = "airline_1234";

Delete an Airline:

DELETE FROM `travel-sample`.inventory.airline WHERE META().id = "airline_1234";

Conclusion

This demo application provides a comprehensive example of how to implement and use GraphQL and REST interfaces with a Couchbase database. It demonstrates the flexibility of GraphQL for querying specific data and the simplicity of REST for traditional API interactions. By following the steps outlined above, you can easily set up, run, and test the application.