chore: readme updated with specific details

Author: aswanyaugustine1992

dbquery/custom-query/README.md

@@ -1,22 +1,65 @@
-# @dbquery SQL query Snippet
 
-This example demonstrates how to use the `@dbquery` directive with custom SQL queries for `Customer` data in StepZen.
+# SQL Queries with `@dbquery`
 
-## Files
+This snippet demonstrates how to configure the `@dbquery` directive for custom SQL queries.
 
-- **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.
+## Getting Started
 
-## Prerequisites
+[Install](https://www.ibm.com/docs/en/api-connect/ace/saas?topic=setting-up-your-environment) the StepZen command line interface.
 
-- A PostgreSQL database with a `customer` table containing `id`, `name`, and `email` fields.
-- Replace the `uri` in `config.yaml` with your database connection details.
+To run these examples,
 
-## Usage
+- `git clone` this repo
+- Change to the right working directory.
+- run `stepzen deploy`
 
-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.
+This example uses a demo database filled with mock data, you can inspect the `config.yaml` file to find the credentials for this database. Also you can configure the connection in the `config.yaml` file by providing your database credentials.
+
+Here’s a more generalized and specific description of the `@dbquery` directive functionality without referring to any particular data:
+
+---
+
+## The `@dbquery` Directive with SQL Query
+
+The `@dbquery` directive in StepZen is used to connect your GraphQL API to databases and allows you to execute custom SQL queries within your schema. It supports various database types, such as MySQL, PostgreSQL, MSSQL, and Snowflake.
+
+In this snippet, the `query` argument is used to define custom SQL queries for more control over the data being fetched. The functionality of the `query` argument allows for:
+
+- Running complex SQL queries directly from GraphQL fields.
+- Retrieving data from specific columns or joining multiple tables based on your query requirements.
+- Filtering and querying data using SQL syntax when database field names or structures differ from the GraphQL schema.
+
+The `query` argument provides the flexibility to write any SQL statement, while the **configuration** argument references the connection settings defined in the `config.yaml` file.
+
+For example, a query may look like this:
+
+```graphql
+@dbquery(
+  query: "SELECT column1, column2 FROM your_table WHERE condition = $1",
+  type: "postgresql",
+  configuration: "your_config"
+)
+```
+
+This allows you to fetch exactly the data you need, based on the custom SQL query provided. You can adjust the queries to match your database schema and use case.
+
+## Try it Out!
+
+Deploy the schema from `dbquery/pagination` relative to the repository's root directory:
+
+```
+stepzen deploy
+```
+
+Run the [sample operations](operations.graphql):
+
+- **Fetch all customers**:
+  ```
+  stepzen request -f operations.graphql --operation-name=Customers
+  ```
+
+- **Fetch a customer by ID**:
+  ```
+  stepzen request -f operations.graphql --operation-name=Customer --var id=1
+  ```
+  

dbquery/custom-query/api.graphql

@@ -22,32 +22,21 @@ Table structure for 'customer':
     CONSTRAINT customer_email_key UNIQUE (email)  -- Unique constraint on email
   );
 
-  Foreign key references:
-    - customeraddress(customerid) references customer(id)
-    - "order"(customerid) references customer(id)
 """
 type Query {
   # Fetches all customers.
-  getAllCustomers: [Customer]
+  customers: [Customer]
     @dbquery(
       query: "SELECT id, name, email FROM customer",
       type: "postgresql",
       configuration: "postgresql_config"
     )
 
   # Fetches a customer by their ID.
-  getCustomerById(id: Int!): Customer
+  customer(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"
-    )
 }

dbquery/custom-query/config.yaml

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

dbquery/custom-query/operations.graphql

@@ -1,24 +1,15 @@
-# Query to get a customer by ID
-query GetCustomerById {
-  getCustomerById(id: 1) {
+# Retrieve a specific customer by ID
+query Customer {
+  customer(id: 1) {
     id
     name
     email
   }
 }
 
-# Query to search customers by name
-query SearchCustomersByName {
-  searchCustomersByName(name: "John") {
-    id
-    name
-    email
-  }
-}
-
-# Query to get all customers
-query GetAllCustomers {
-  getAllCustomers {
+# Retrieve all customers in the system
+query Customers {
+  customers {
     id
     name
     email

dbquery/custom-query/tests/Test.js

@@ -18,7 +18,7 @@ describe(testDescription, function () {
     {
       label: "fetch all customers",
       query: requests,
-      operationName: "GetAllCustomers",
+      operationName: "Customers",
       variables: {},
       expected: {
         getAllCustomers: [
@@ -38,7 +38,7 @@ describe(testDescription, function () {
     {
       label: "fetch customer by ID",
       query: requests,
-      operationName: "GetCustomerById",
+      operationName: "Customer",
       variables: { 
         id: 1  
       },
@@ -50,23 +50,6 @@ describe(testDescription, function () {
         }
       },
     },
-    {
-      label: "search customers by name pattern",
-      query: requests,
-      operationName: "SearchCustomersByName",
-      variables: {
-        name: "John"
-      },
-      expected: {
-        searchCustomersByName: [
-          { 
-            id: "5",
-            email: "[email protected]                              ",
-            name: "John Doe                                          "
-          }
-        ]
-      },
-    },
   ];
 
   // Run the tests against the deployed schema