Python DB-API and SQLAlchemy interface for GraphQL APIs.
Project description
graphql-db-api
A Python DB API 2.0 for GraphQL APIs
This module allows you to query GraphQL APIs using SQL.
SQLAlchemy support
This module provides a SQLAlchemy dialect.
from sqlalchemy.engine import create_engine
engine = create_engine('graphql://host:port/path?is_https=0')
Example Usage
Querying Connections
from sqlalchemy import create_engine
from sqlalchemy import text
# We use GraphQL SWAPI (The Star Wars API) c/o Netlify:
engine = create_engine('graphql://swapi-graphql.netlify.app/.netlify/functions/index')
with engine.connect() as connection:
# Demonstration of requesting nested resource of homeworld
# and then selecting fields from it
for row in connection.execute(text("select name, homeworld__name from 'allPeople?include=homeworld'")):
print(row)
Querying Lists
from sqlalchemy import create_engine
from sqlalchemy import text
engine = create_engine('graphql://pet-library.moonhighway.com/')
with engine.connect() as connection:
for row in connection.execute(text("select id, name from 'allPets?is_connection=0'")):
print(row)
Superset support
In order to use with Superset, install this package and then use the graphql
protocol in the SQLAlchemy URI like: graphql://swapi-graphql.netlify.app/.netlify/functions/index
. We install a db_engine_spec
so Superset should recognize the driver.
Roadmap
- Non-Connections top level
- Path traversal (basic)
- Path traversal (basic + nested)
- Path traversal (list / connection)
- Bearer Tokens in
Authorization
Header - Advanced Auth (e.g. with token refresh)
- Passing Headers (e.g. Auth in other locations)
- Filtering
- Sorting
- Relay Pagination
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for hakurei_sqlalchemy-graphqlapi-0.0.1.dev17.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2c9f3e076a3e347282502c8a74d211839b2bfc3320a96e8c0ab37b56ff4847f2 |
|
MD5 | 0c88780644791a964b73b944a0fbc2a7 |
|
BLAKE2b-256 | 5ad96c0b967c5e80cf8a53968f11aaca1f3830c13ca3132347d38394b5e9b8cd |
Close
Hashes for hakurei_sqlalchemy_graphqlapi-0.0.1.dev17-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 07554bbccb5d03999905547fce4d05e64237864f726d851c98791d242679c81d |
|
MD5 | 4f77eda49ca882c0121c657cd6682929 |
|
BLAKE2b-256 | 63efabd3e30ca5a6b1634a77a70096ca5a47aa84d38f2ea4fe713b1bb2216a72 |