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.dev1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e03cffe66cc383b49a41a3caa4c263f503c5e85348865819f63f50bbee05fa9a |
|
MD5 | 8638377a32036c0bc7f9e37248b0dce9 |
|
BLAKE2b-256 | e965b84c868dcca7f23e7bd8c3b7e2f67c3500ed41ec7da53f3bf30e31b831c1 |
Close
Hashes for hakurei_sqlalchemy_graphqlapi-0.0.1.dev1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d9aa4fba8dc04660ddaa901bb46fa44362df35e07344e80abbd79e267c8b7545 |
|
MD5 | 39b0bd7937711c45fadf82fc023d9e35 |
|
BLAKE2b-256 | 0f01129be812e38eb112f77277aa2d9b0bc510ddeb7784579eacb769cc030be2 |