Basic Operations

This guide covers the essential CRUD (Create, Read, Update, Delete) operations using ekoDB client libraries.

tip

For complete, runnable examples, visit the ekoDB Examples Repository. It contains 105 working examples across all languages.

Prerequisites

Before you begin, make sure you have:

1. ✅ Installed the client library
2. ✅ Retrieved your API key

Client Initialization

🦀 Rust

use ekodb_client::Client;

let client = Client::builder()
    .base_url("https://your-subdomain.production.aws.ekodb.io")
    .api_key("your-api-key")
    .build()?;

🐍 Python

from ekodb_client import Client

client = Client.new(
    "https://your-subdomain.production.aws.ekodb.io",
    "your-api-key"
)

📘 TypeScript

import { EkoDBClient } from "@ekodb/ekodb-client";

const client = new EkoDBClient({
  baseURL: "https://your-subdomain.production.aws.ekodb.io",
  apiKey: "your-api-key"
});
await client.init();

🔷 Go

import "github.com/ekoDB/ekodb-client-go"

client := ekodb.NewClient(
    "https://your-subdomain.production.aws.ekodb.io",
    "your-api-key",
)

🟣 Kotlin

import io.ekodb.client.EkoDBClient

val client = EkoDBClient.Builder()
    .baseUrl("https://your-subdomain.production.aws.ekodb.io")
    .apiKey("your-api-key")
    .build()

📦 JavaScript

const { EkoDBClient } = require("@ekodb/ekodb-client");

const client = new EkoDBClient({
  baseURL: "https://your-subdomain.production.aws.ekodb.io",
  apiKey: "your-api-key"
});
await client.init();

Insert Records

Create new records in a collection:

🦀 Rust

use ekodb_client::Record;

let mut user = Record::new();
user.insert("name", "Alice Smith");
user.insert("email", "alice@example.com");
user.insert("age", 28);

let result = client.insert("users", user).await?;
println!("Created user with ID: {:?}", result.get("id"));

🐍 Python

user = {
    "name": "Alice Smith",
    "email": "alice@example.com",
    "age": 28
}

result = await client.insert("users", user)
print(f"Created user with ID: {result['id']}")

📘 TypeScript

const user = {
  name: "Alice Smith",
  email: "alice@example.com",
  age: 28
};

const result = await client.insert("users", user);
console.log(`Created user with ID: ${result.id}`);

🔷 Go

user := map[string]interface{}{
    "name": "Alice Smith",
    "email": "alice@example.com",
    "age": 28,
}

result, err := client.Insert("users", user)
if err != nil {
    log.Fatal(err)
}
fmt.Printf("Created user with ID: %s\n", result["id"])

🟣 Kotlin

import io.ekodb.client.types.Record

val user = Record.new()
    .insert("name", "Alice Smith")
    .insert("email", "alice@example.com")
    .insert("age", 28)

val result = client.insert("users", user)
println("Created user with ID: ${result["id"]}")

📦 JavaScript

const user = {
  name: "Alice Smith",
  email: "alice@example.com",
  age: 28
};

const result = await client.insert("users", user);
console.log(`Created user with ID: ${result.id}`);

Find Records

Find by ID

🦀 Rust

let user = client.find_by_id("users", "user-id-123").await?;
println!("Found user: {:?}", user);

🐍 Python

user = await client.find_by_id("users", "user-id-123")
print(f"Found user: {user}")

📘 TypeScript

const user = await client.findByID("users", "user-id-123");
console.log("Found user:", user);

🔷 Go

user, err := client.FindByID("users", "user-id-123")
if err != nil {
    log.Fatal(err)
}
fmt.Printf("Found user: %+v\n", user)

🟣 Kotlin

val user = client.findById("users", "user-id-123")
println("Found user: $user")

📦 JavaScript

const user = await client.findByID("users", "user-id-123");
console.log("Found user:", user);

Find All Records

🦀 Rust

let users = client.find_all("users").await?;
println!("Found {} users", users.len());

🐍 Python

users = await client.find("users", limit=100)
print(f"Found {len(users)} users")

📘 TypeScript

const users = await client.find("users", { limit: 100 });
console.log(`Found ${users.length} users`);

🔷 Go

users, err := client.Find("users", map[string]interface{}{"limit": 100})
if err != nil {
    log.Fatal(err)
}
fmt.Printf("Found %d users\n", len(users))

🟣 Kotlin

val users = client.find("users", limit = 100)
println("Found ${users.size} users")

📦 JavaScript

const users = await client.find("users", { limit: 100 });
console.log(`Found ${users.length} users`);

Update Records

🦀 Rust

let mut updates = Record::new();
updates.insert("age", 29);
updates.insert("email", "alice.smith@example.com");

let updated = client.update("users", "user-id-123", updates).await?;
println!("Updated user: {:?}", updated);

🐍 Python

updates = {
    "age": 29,
    "email": "alice.smith@example.com"
}

updated = await client.update("users", "user-id-123", updates)
print(f"Updated user: {updated}")

📘 TypeScript

const updates = {
  age: 29,
  email: "alice.smith@example.com"
};

const updated = await client.update("users", "user-id-123", updates);
console.log("Updated user:", updated);

🔷 Go

updates := map[string]interface{}{
    "age": 29,
    "email": "alice.smith@example.com",
}

updated, err := client.Update("users", "user-id-123", updates)
if err != nil {
    log.Fatal(err)
}
fmt.Printf("Updated user: %+v\n", updated)

🟣 Kotlin

val updates = Record.new()
    .insert("age", 29)
    .insert("email", "alice.smith@example.com")

val updated = client.update("users", "user-id-123", updates)
println("Updated user: $updated")

📦 JavaScript

const updates = {
  age: 29,
  email: "alice.smith@example.com"
};

const updated = await client.update("users", "user-id-123", updates);
console.log("Updated user:", updated);

Delete Records

🦀 Rust

client.delete("users", "user-id-123").await?;
println!("User deleted successfully");

🐍 Python

await client.delete("users", "user-id-123")
print("User deleted successfully")

📘 TypeScript

await client.delete("users", "user-id-123");
console.log("User deleted successfully");

🔷 Go

err := client.Delete("users", "user-id-123")
if err != nil {
    log.Fatal(err)
}
fmt.Println("User deleted successfully")

🟣 Kotlin

client.delete("users", "user-id-123")
println("User deleted successfully")

📦 JavaScript

await client.delete("users", "user-id-123");
console.log("User deleted successfully");

Collection Management

List Collections

🦀 Rust

let collections = client.list_collections().await?;
println!("Collections: {:?}", collections);

🐍 Python

collections = await client.list_collections()
print(f"Collections: {collections}")

📘 TypeScript

const collections = await client.listCollections();
console.log("Collections:", collections);

🔷 Go

collections, err := client.ListCollections()
if err != nil {
    log.Fatal(err)
}
fmt.Printf("Collections: %v\n", collections)

🟣 Kotlin

val collections = client.listCollections()
println("Collections: $collections")

📦 JavaScript

const collections = await client.listCollections();
console.log("Collections:", collections);

Delete Collection

🦀 Rust

client.delete_collection("old_data").await?;
println!("Collection deleted");

🐍 Python

await client.delete_collection("old_data")
print("Collection deleted")

📘 TypeScript

await client.deleteCollection("old_data");
console.log("Collection deleted");

🔷 Go

err := client.DeleteCollection("old_data")
if err != nil {
    log.Fatal(err)
}
fmt.Println("Collection deleted")

🟣 Kotlin

client.deleteCollection("old_data")
println("Collection deleted")

📦 JavaScript

await client.deleteCollection("old_data");
console.log("Collection deleted");

Complete Examples

For complete, runnable examples with error handling and advanced features, visit:

📚 Example Repository

ekoDB Client Examples

The repository contains 77 client library examples organized by language:

• Rust Examples - 14 examples including CRUD, queries, search, batch operations
• Python Examples - 14 examples with async/await patterns
• TypeScript Examples - 14 examples for Node.js and browsers
• Go Examples - 14 examples with idiomatic Go patterns
• Kotlin Examples - 14 examples with coroutines
• JavaScript Examples - 7 examples for Node.js

Featured Examples

• Simple CRUD - Basic create, read, update, delete operations
• Query Builder - Complex queries with filters, sorting, pagination
• Batch Operations - Efficient bulk inserts, updates, deletes
• Search - Full-text search with scoring
• Schema Management - Define and enforce data schemas
• WebSocket - Real-time queries and subscriptions
• TTL - Automatic document expiration
• Key-Value - Simple key-value store operations

Running Examples

# Clone the repository
git clone https://github.com/ekoDB/ekodb-client.git
cd ekodb-client/examples

# Set up environment
cp .env.example .env
# Edit .env with your API URL and key

# Run all examples
make test-examples

# Run specific language examples
make test-examples-rust
make test-examples-python
make test-examples-typescript
make test-examples-kotlin
make test-examples-javascript

# To run this directly without package installation, 
# go to https://github.com/ekoDB/ekodb-client-go 
# and use the file path to run the example
make test-examples-go

Next Steps

• More Examples - Query builder, search, batch operations, and more
• API Reference - Direct HTTP API documentation
• Authentication - Learn about API keys and permissions

Need Help?

• 📧 Email: support@ekodb.io
• 🐛 Issues: GitHub Issues
• 💬 Discussions: GitHub Discussions