GraphQL Protocol Support¶
HeliosDB provides a fully-featured GraphQL API with auto-generated schemas, subscriptions, and federation support.
Overview¶
| Property | Value |
|---|---|
| Protocol | GraphQL over HTTP |
| Port | 443 (HTTPS), 8080 (HTTP) |
| Status | Production |
| Compatibility | 80%+ |
| Test Coverage | 80%+ |
Quick Start¶
GraphQL Playground¶
Access the interactive GraphQL Playground at:
Query Example¶
query GetUsers {
users(where: { status: { _eq: "active" } }, limit: 10) {
id
name
email
orders {
id
total
created_at
}
}
}
cURL¶
curl -X POST https://localhost:443/graphql \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"query": "query { users(limit: 10) { id name email } }"
}'
JavaScript (Apollo Client)¶
import { ApolloClient, InMemoryCache, gql } from '@apollo/client';
const client = new ApolloClient({
uri: 'https://localhost:443/graphql',
cache: new InMemoryCache(),
headers: {
Authorization: 'Bearer YOUR_API_KEY'
}
});
const { data } = await client.query({
query: gql`
query GetUsers {
users(limit: 10) {
id
name
email
}
}
`
});
Python (gql)¶
from gql import gql, Client
from gql.transport.requests import RequestsHTTPTransport
transport = RequestsHTTPTransport(
url="https://localhost:443/graphql",
headers={"Authorization": "Bearer YOUR_API_KEY"}
)
client = Client(transport=transport)
query = gql("""
query GetUsers {
users(limit: 10) {
id
name
email
}
}
""")
result = client.execute(query)
Key Features¶
- Auto-generated GraphQL schema from database tables
- Real-time subscriptions via WebSocket
- Query batching and DataLoader integration
- Schema federation for distributed architectures
- Built-in query complexity analysis
- N+1 query prevention
Documentation¶
- CONFIGURATION.md - Server configuration options
- COMPATIBILITY.md - Feature compatibility matrix
- EXAMPLES.md - Code examples and patterns
Related Resources¶
- GraphQL Package Docs - Implementation details
- HTTP/REST API - REST alternative
Last Updated: January 2026