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.dev15.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4796c7650f44c54b3066f03bc1100c095bf918c151e6255feb74b1a6cc90fb92 |
|
MD5 | 567b0c864738b58d66ab3d7f8e6c0921 |
|
BLAKE2b-256 | 70efb4d0d6fd267b4d5466f6e2c8db8547333fe2b30455ea3da446c3928afa7e |
Close
Hashes for hakurei_sqlalchemy_graphqlapi-0.0.1.dev15-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 40f1186cc94c1304c249361b52e6c256c6bef7092319a6745f57fa5d76b602f3 |
|
MD5 | cd1a549c8eae48bf7880560aab320f5b |
|
BLAKE2b-256 | 4e9daf872c3c99b406fd5d1de76ca63484a26c227a0620cc9d00697f28c668c0 |