feat(snippet): add example for @dbquery with SQL queries

Author: aswanyaugustine1992

dbquery/custom-query/README.md

@@ -0,0 +1,22 @@
+# @dbquery Example Snippet
+
+This example demonstrates how to use the `@dbquery` directive with custom SQL queries for `Customer` data in StepZen.
+
+## Files
+
+- **api.graphql**: Contains the GraphQL schema for querying `Customer` objects using custom SQL queries.
+- **config.yaml**: Database configuration, including connection URI.
+- **index.graphql**: Entry point schema file.
+- **operations.graphql**: Sample queries to test the `@dbquery` directive.
+- **stepzen.config.json**: Configuration for the StepZen endpoint.
+
+## Prerequisites
+
+- A PostgreSQL database with a `customer` table containing `id`, `name`, and `email` fields.
+- Replace the `uri` in `config.yaml` with your database connection details.
+
+## Usage
+
+1. Deploy the schema using StepZen.
+2. Use the sample queries in `operations.graphql` to test the `@dbquery` functionality.
+3. Adjust the queries as needed to fit your database schema.

dbquery/custom-query/api.graphql

@@ -0,0 +1,54 @@
+# This example shows how @dbquery is configured for custom SQL queries with Customer data.
+
+"""
+Sample Customer type.
+"""
+type Customer {
+  id: ID!
+  name: String
+  email: String
+}
+
+"""
+`Customer` queries a mock `Customer` object from a demo PostgreSQL database.
+The data is fetched using custom SQL queries.
+"""
+type Query {
+    # Fetches all customers.
+  getAllCustomers: [Customer]
+    @dbquery(
+      query: "SELECT id, name, email FROM customer"
+      type: "postgresql"
+      configuration: "postgresql_config"
+    )
+  # Fetches a customer by their ID.
+getCustomerById(id: Int!): Customer
+    @dbquery(
+      query: "SELECT id, name, email FROM customer WHERE id = $1"
+      type: "postgresql"
+      configuration: "postgresql_config"
+    )
+
+  
+  # Searches customers by name using a pattern match.
+  searchCustomersByName(name: String!): [Customer]
+    @dbquery(
+      query: "SELECT id, name, email FROM customer WHERE name LIKE '%' ||  $1 || '%'"
+      type: "postgresql"
+      configuration: "postgresql_config"
+    )
+}
+type Mutation {
+  # Updates a customer's email by their ID.
+  updateCustomerEmail(id: Int!, newEmail: String!): Customer
+    @dbquery(
+      query: """
+      UPDATE customer
+      SET email = $2
+      WHERE id = $1
+      RETURNING id, name, email
+      """
+      type: "postgresql"
+      configuration: "postgresql_config"
+    )
+}

dbquery/custom-query/config.yaml

@@ -0,0 +1,4 @@
+configurationset:
+  - configuration:
+      name: postgresql_config
+      uri: postgresql://postgresql.introspection.stepzen.net/introspection?user=testUserIntrospection&password=HurricaneStartingSample1934

dbquery/custom-query/index.graphql

@@ -0,0 +1,3 @@
+schema @sdl(files: ["api.graphql"]) {
+  query: Query
+}

dbquery/custom-query/operations.graphql

@@ -0,0 +1,17 @@
+# Query to get a customer by ID
+query GetCustomerById {
+  getCustomerById(id: 1) {
+    id
+    name
+    email
+  }
+}
+
+# Query to search customers by name
+query SearchCustomersByName {
+  searchCustomersByName(name: "John") {
+    id
+    name
+    email
+  }
+}

dbquery/custom-query/stepzen.config.json

@@ -0,0 +1,4 @@
+{
+    "endpoint": "api/miscellaneous"
+  }
+  

dbquery/custom-query/tests/Test.js

@@ -0,0 +1,58 @@
+const fs = require("fs");
+const path = require("node:path");
+const {
+  deployAndRun,
+  stepzen,
+  getTestDescription,
+} = require("../../../tests/gqltest.js");
+
+testDescription = getTestDescription("snippets", __dirname);
+
+// Read the GraphQL operations from the operations file
+const requestsFile = path.join(path.dirname(__dirname), "operations.graphql");
+const requests = fs.readFileSync(requestsFile, "utf8").toString();
+
+describe(testDescription, function () {
+  const tests = [
+    {
+      label: "fetch customer by ID",
+      query: requests,
+      operationName: "GetCustomerById",
+      variables: { 
+        id: 1 
+      },
+      expected: {
+        getCustomerById: {
+          id: "1",
+          name: "Lucas Bill",
+          email: "[email protected]"
+        }
+      },
+    },
+    {
+      label: "search customers by name pattern",
+      query: requests,
+      operationName: "SearchCustomersByName",
+      variables: {
+        name: "John"
+      },
+      expected: {
+        searchCustomersByName: [
+          {
+            id: "2",
+            name: "John Doe",
+            email: "[email protected]"
+          },
+          {
+            id: "5",
+            name: "Johnny Smith",
+            email: "[email protected]"
+          }
+        ]
+      },
+    },
+  ];
+  
+  // Run the tests against the deployed schema
+  return deployAndRun(__dirname, tests, stepzen.admin);
+});