Skip to content

SQL Executor

SQL executor allows you to execute SQL code via any database supported by SqlAlchemy.

Install

Ensure that garf-executors library is installed with SqlAlchemy support:

pip install garf-executors[sql]

Usage

After garf-executors is installed you can use garf utility to perform fetching.

Important

sql executor expects a connection_string parameter in SqlAlchemy format. If it's not provided queries are executed via in-memory sqlite database.

echo "SELECT campaign_id FROM table" > query.sql

garf query.sql --source sqldb \
  --output csv
where

  • query- local or remote path(s) to files with queries.
  • output - output supported by garf-io library.
from garf.executors.sql_executor import SqlAlchemyQueryExecutor


query_executor = SqlAlchemyQueryExecutor()

query_text = "SELECT campaign_id FROM table"

# execute query and get report back
report = query_executor.execute(query=query_text, title="campaign")

# execute query and save results to `campaign.csv`
query_executor.execute(
  query=query_text,
  title="campaign",
  context={'writer': 'csv'}
)

curl -X 'POST' \
  'http://127.0.0.1:8000/api/execute' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "source": "sqldb",
  "query": "SELECT campaign_id FROM table",
  "title": "campaign",
  "context": {
    "writer": "csv"
  }
}'

Parameters

connection_string

SqlAlchemyQueryExecutor requires connection string to the database.

garf query.sql --source sqldb \
  --output csv \
  --sqldb.connection_string=DB_CONNECTION_STRING

from garf.executors.sql_executor import SqlAlchemyQueryExecutor

query_executor = (
  SqlAlchemyQueryExecutor.from_connection_string('DB_CONNECTION_STRING')
)

curl -X 'POST' \
  'http://127.0.0.1:8000/api/execute' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "source": "sqldb",
  "query": "SELECT campaign_id FROM table",
  "title": "campaign",
  "context": {
    "writer": "csv",
    "fetcher_parameters": {
      "connection_string": "DB_CONNECTION_STRING"
    }
  }
}'