docsOverview

MemQL tech stack

MemQL runs as specialized services in one cluster. Clients connect to the engine; they do not connect directly to its storage.

LayerImplementationWhat it means for you
EngineGo; module minimum and selected toolchain are declared in go.modBuild with the repository's toolchain rather than a guessed version
DataPostgreSQL 16, TimescaleDB, pgvector, managed by CloudNativePGVersioned records, time-oriented retrieval, and vector support underneath the platform
Engine APIgRPC MemqlService.Stream; WebSocket bridge for browsersUse the Go or TypeScript SDK for typed operations
HTTP edgeHostname-based static site serving, runtime configuration, health and identity endpointsHTTP complements the engine API; there is no general REST CRUD API to substitute for it
Language.memql declarations, compiler, registries, and MemQL SenseThe editor and engine share language intelligence
IdentityCluster-owned identity service, OAuth/PKCE, passkeys, magic links, JWT/JWKSSign in to the cluster that owns the resource
AILevel/policy/rule routing across configured sourcesLocal resources and vendor integrations have explicit readiness and permission requirements
Browser clientMemQL OS: React, TypeScript, ViteA static SPA served by the edge as an ordinary site
EditorTypeScript VS Code extension and bundled Go language serverOffline authoring; optional authenticated runtime connection
DeploymentDocker images, Kubernetes/Kustomize, ArgoCDk3d locally; the supported cloud overlay targets AKS

Local and cloud operation

Local Kubernetes runs inside Docker through k3d. ArgoCD reconciles the cluster's manifests; the front door uses HTTPS hostnames such as os.memql.localhost and api.memql.localhost. Debug port-forwards are optional, not the regular client connection. The initial local build uses make up; the engine development loop uses make dev.

Cloud installations use the same base manifests with environment configuration and pinned images. GitOps changes update the deployed revision; do not replace this workflow with an ad hoc application server or direct production rollout. The same topology does not imply identical hardware capacity or performance.

Build a client

Use the SDKs and client model. A site build emits a folder of static files with index.html at its root; the edge serves it without a Node.js runtime. MemQL OS is a worked example. A product's client can also be hosted elsewhere and connect through the supported API.

Site hosting · TypeScript SDK · Go SDK · Contributing.