IBM-Cloud/sql-query-clients

Client samples for IBM Cloud SQL Query service

sql-query-clients

This repository contains application client samples and blueprint code for the IBM Cloud Data Engine service.

List of clients

• ibmcloudsql Python SDK
• Cloud Function for Data Engine (uses ibmcloudsql)
• sqlQuery Node SDK deprecated (Use this Data Engine Node SDK instead)
• Dremio connector
• Grafana connector

Documentation

• Please refer to Data Engine Getting Started for general information and turorial for this service.
• The documentation for ibmcloudsql Python API
• How to use ibmcloudsql in a Python Notebook

How to generate docs

Requirement: conda

• In the docs folder, you run [if you don’t have sphinx and required package yet]

make setup

This create sphinx environment. Make sure you're in this environment each time you run the below commands

• Get docstring updated

make python

• generate docs in local file (in /tmp/sql-query-clients-docs/html - for the purpose of local check the output)

make html

Check the output by opening the browser with the URL: file:///tmp/sql-query-clients-docs/html/index.html

• (check the local content carefully before running this) generate and commit to the server [only those with proper priviledges]

make buildandcommithtml