Skip to main content

Crate fraiseql_server

Crate fraiseql_server 

Source
Expand description

FraiseQL HTTP Server

HTTP server for FraiseQL v2 compiled GraphQL execution engine.

§Architecture

The server exposes a GraphQL HTTP endpoint that:

  1. Receives GraphQL queries via POST
  2. Executes queries using the runtime Executor
  3. Returns GraphQL-compliant JSON responses

§Features

  • GraphQL endpoint (/graphql)
  • Health check endpoint (/health)
  • Schema introspection endpoint (/introspection)
  • CORS support
  • Compression (gzip, br, zstd)
  • Request tracing
  • APQ (Automatic Persisted Queries)
  • Query caching
  • Authentication middleware (optional)

Re-exports§

pub use cli::Cli;
pub use cli::ServerArgs;
pub use logging::ErrorDetails;
pub use logging::LogLevel;
pub use logging::LogMetrics;
pub use logging::RequestContext;
pub use logging::RequestId;
pub use logging::RequestLogger;
pub use logging::SourceLocation;
pub use logging::StructuredLogEntry;
pub use metrics_server::MetricsCollector;
pub use metrics_server::PrometheusMetrics;
pub use schema::CompiledSchemaLoader;
pub use server::Server;
pub use server_config::ServerConfig;
pub use tls::TlsSetup;
pub use fraiseql_auth as auth;

Modules§

api
API endpoints for FraiseQL Server
api_key
API key authentication.
cli
Clap-based CLI argument parsing for fraiseql-server.
config
Runtime configuration types loaded from fraiseql.toml or environment variables. Runtime configuration types for the FraiseQL server.
error
GraphQL error response handling.
extractors
Custom extractors for GraphQL handlers.
identity
Enriched-identity resolution: a request-scoped sub → DB → identity mapping.
logging
Structured JSON logging for observability.
metrics_server
Canonical metrics implementation for fraiseql-server.
middleware
HTTP middleware.
pool
Connection pool management.
prelude
Convenience re-exports for building a FraiseQL HTTP server.
realtime
Realtime broadcast observer — entity change streams over WebSocket.
resilience
Resilience primitives: backpressure and retry policies. Resilience primitives for the FraiseQL server.
routes
HTTP routes.
schema
Schema loading and management.
server
HTTP server implementation.
server_config
Server configuration (*Config types).
sql_source_check
Opt-in fail-fast sql_source existence check at server boot (#487).
storage
Object storage backends for file upload and download.
subscriptions
Subscription infrastructure for FraiseQL
subsystems
Server subsystem assembly and lifecycle management.
tenancy
Multi-tenancy infrastructure: pool factory, executor construction, health monitoring.
tls
TLS/SSL configuration for database connections.
token_revocation
Token revocation — reject JWTs whose jti claim has been revoked.
tracing_utils
Stub tracing utilities when federation is disabled.
trusted_documents
Trusted documents / query allowlist.
url_guard
Startup-time validation that the database URL scheme matches a known FraiseQL adapter, with feature-gated dispatch to the matching adapter.
usage
Usage aggregation subsystem.
validation
GraphQL request validation — re-exported from fraiseql-core.

Structs§

RequestValidator
AST-based GraphQL request validator.

Enums§

ComplexityValidationError
GraphQL query validation error types (depth, complexity, aliases).
ServerError
Server error type.

Type Aliases§

Result
Server result type.