Choose Your Path
Not sure where to begin? This guide helps you find the right documentation for your needs.
🚀 Most Popular: Quick Start​
Just want to get running?
→ 5-Minute Quick Start - Deploy, insert, and query your first record
Perfect for: First-time users, proof of concepts, testing ekoDB
🎯 What's Your Main Goal?​
📱 Build an Application (Web, Mobile, Backend)​
Use our client libraries for the best developer experience
What you get:
- Type-safe SDKs (TypeScript, Python, Rust, Go, Kotlin)
- Auto-complete in your IDE
- Built-in authentication & retry logic
- WebSocket support for real-time features
Start here: Installation → Basic Operations
🔌 Direct API Integration​
Use HTTP REST API directly without SDKs
Perfect for:
- Serverless functions (Lambda, Cloudflare Workers)
- Languages without official client libraries
- Custom integrations
- Microservices
Start here: Basic Operations → Authentication
🤖 AI/ML Application (built into your database)​
Build with vector search, embeddings, and RAG — no separate AI service
→ Chat & RAG + Vector Search
What you get:
- High-performance vector search
- Semantic similarity & hybrid search
- Built-in chat session management with RAG over your own collections
- Native LLM integration (OpenAI, Claude, Gemini)
Start here: Chat & RAG → Advanced Operations
🦾 Autonomous AI Agents​
Deploy an agent that uses tools, pursues goals, and runs scheduled tasks
What you get:
- A separate AI Agent deployment that connects to your database
- Tools, goals, scheduled tasks, persistent memory, and ready-made templates
- Customer-facing agent endpoints with scoped permissions
- Built on the same chat/RAG primitives above
Start here: AI Agents → Build Your First AI Agent
Note: an agent always connects to a database — deploy a database first (or alongside it).
⚡ High Performance / Scale​
Optimize for speed and throughput
→ Batch Operations + White Paper
What you get:
- Bulk insert/update/delete operations
- ACID transactions with savepoints
- Performance tuning guidance
Start here: Batch Operations → Transactions
📚 Need Something Specific?​
Transactions & ACID Guarantees​
Multi-document transactions, isolation levels, savepoints, automatic rollback
Stored Procedures / Reusable Logic​
→ Functions
JSON-based function composition, parameterized queries, version control
Search (Full-Text / Vector / Hybrid)​
→ Advanced Operations - Search
Text search, vector search, fuzzy matching, hybrid search
Real-Time / WebSocket​
→ Advanced Operations - Real-Time
Live queries, WebSocket subscriptions, TTL-based expiration
Multi-Region Replication​
→ White Paper - Ripple Section
Cross-instance replication, data propagation, automatic failover
Key-Value Store​
→ KV Store Guide
Fast in-memory caching, TTL expiration, document linking
🆘 Still Not Sure?​
Quick Decision Tree:
-
First time with ekoDB?
- → Quick Start (Start here!)
-
Building an app?
- Want type safety? → Client Libraries
- Prefer HTTP calls? → REST API
-
Building with AI?
- Chat/RAG/vector in your app? → Chat & RAG
- Want an autonomous agent (tools, goals, schedules)? → Build Your First AI Agent
-
Need extreme performance?
- → Batch Operations + Functions
-
Want to understand architecture?
- → White Paper
📞 Need Help?​
- Email: support@ekodb.io
- Support Portal: app.ekodb.io/support
Ready to start? Pick your path above and let's build! 🚀