SyntricDB | Next-Generation AI-Native Unified Database Engine

Documentation & Tutorials

Multi-Language Developer Integration Hub

Complete code examples and SDK guides for Python, Node.js, Java, Go, C#, Rust, PHP, Swift, Kotlin, Ruby, and REST API.

🚀 Quickstart & One-Line Installers

SyntricDB can be installed instantly on macOS, Linux, Windows, Docker, or AWS EC2 using official single-command installers.

🍏 macOS & Linux Terminal

bash

curl -fsSL https://raw.githubusercontent.com/upendra-manike/SyntricDB/main/deploy/mac/install_mac.sh | bash

🪟 Windows 10 / 11 / Server (PowerShell)

powershell

powershell -ExecutionPolicy Bypass -Command "iwr -useb https://raw.githubusercontent.com/upendra-manike/SyntricDB/main/deploy/windows/install_windows.ps1 | iex"

🐳 Docker Container

docker

docker run -d -p 8080:8080 --name syntricdb syntricdb/syntricdb:latest

🔑 Default Access Credentials

Username: admin
Password: syntricdb_secret_pass
URI: syntricdb://admin:syntricdb_secret_pass@localhost:8080/default
Web Dashboard: http://localhost:8080/
REST SQL API: http://localhost:8080/api/sql

💻 CLI Utilization Guide (`syntricdb-cli`)

The SyntricDB Command Line Interface allows developers to manage tables, run SQL & AI vector queries, monitor cluster state, and stream WAL logs.

1. Interactive CLI Connection

bash

syntricdb-cli --host localhost --port 8080 --user admin --password syntricdb_secret_pass

2. Single Query Execution

bash

syntricdb-cli --exec "SELECT * FROM products WHERE embedding SIMILAR TO 'laptop' TOP 5;"

📖 Unified SQL & AI Function Reference

SyntricDB seamlessly blends ANSI SQL with AI Vector Search, BM25 scoring, and ACID transactions.

Vector Similarity Search

sql

SELECT id, title, price 
FROM products 
WHERE category = 'Electronics' 
  AND embedding SIMILAR TO 'noise canceling headphones' TOP 5;

🐍 Official Python Client SDK

Install via PyPI: pip install syntricdb-client

python

from syntricdb import SyntricDBClient

client = SyntricDBClient(host="http://localhost:8080", api_key="syntricdb_secret_pass")

# 1. Execute SQL Query
res = client.query("SELECT * FROM products WHERE price < 100.00 LIMIT 10")
print("SQL Results:", res)

# 2. HNSW Vector Similarity Search
vectors = client.vector_search(table="products", column="embedding", query="wireless gaming mouse", limit=3)
print("Vector Matches:", vectors)

💚 Official Node.js / TypeScript Client SDK

Install via npm: npm install syntricdb-client

typescript

import { SyntricDBClient } from 'syntricdb-client';

const client = new SyntricDBClient({
  endpoint: 'http://localhost:8080',
  username: 'admin',
  password: 'syntricdb_secret_pass'
});

async function run() {
  const matches = await client.vectorSearch({
    table: 'products',
    query: '4k gaming monitor',
    limit: 5
  });
  console.log('Top Vector Results:', matches);
}

run();

☕ Java & Spring Boot JPA Integration

Integrate SyntricDB into Spring Boot with zero extra dependencies using standard JPA Repositories.

java

@Repository
public interface ProductRepository extends JpaRepository<Product, String> {

    @Query(value = "SELECT * FROM products WHERE category = :cat AND embedding SIMILAR TO :term TOP :limit", nativeQuery = true)
    List<Product> searchByVectorSimilarity(@Param("cat") String category, 
                                           @Param("term") String searchTerm, 
                                           @Param("limit") int limit);
}

🔷 Go (Golang) Integration

package main

import (
    "bytes"
    "fmt"
    "net/http"
)

func main() {
    jsonPayload := []byte(`{"sql": "SELECT * FROM products WHERE embedding SIMILAR TO 'mechanical keyboard' TOP 3"}`)
    req, _ := http.NewRequest("POST", "http://localhost:8080/api/sql", bytes.NewBuffer(jsonPayload))
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err == nil {
        fmt.Println("SyntricDB Response Code:", resp.StatusCode)
    }
}

💜 C# / .NET 8 Integration

csharp

using System.Net.Http.Json;

var client = new HttpClient();
var payload = new { sql = "SELECT * FROM products WHERE embedding SIMILAR TO 'curved monitor' TOP 3" };
var response = await client.PostAsJsonAsync("http://localhost:8080/api/sql", payload);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

🦀 Rust Integration

rust

use reqwest::Client;
use serde_json::json;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let res = client.post("http://localhost:8080/api/sql")
        .json(&json!({ "sql": "SELECT * FROM products WHERE embedding SIMILAR TO 'mesh chair' TOP 3" }))
        .send()
        .await?;
    println!("SyntricDB Rust Result: {}", res.text().await?);
    Ok(())
}

🐘 PHP Integration

php

<?php
$ch = curl_init('http://localhost:8080/api/sql');
$payload = json_encode(['sql' => "SELECT * FROM products WHERE embedding SIMILAR TO 'wireless headphones' TOP 3"]);

curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type:application/json']);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$result = curl_exec($ch);
curl_close($ch);

echo "SyntricDB PHP Output: " . $result;
?>

🍎 Swift (iOS / macOS) Integration

swift

import Foundation

func querySyntricDB() async throws {
    let url = URL(string: "http://localhost:8080/api/sql")!
    var request = URLRequest(url: url)
    request.httpMethod = "POST"
    request.setValue("application/json", forHTTPHeaderField: "Content-Type")
    
    let json = ["sql": "SELECT * FROM products WHERE embedding SIMILAR TO 'macbook stand' TOP 3"]
    request.httpBody = try JSONSerialization.data(withJSONObject: json)
    
    let (data, _) = try await URLSession.shared.data(for: request)
    print("SyntricDB Swift Result:", String(data: data, encoding: .utf8)!)
}

🤖 Kotlin (Android / JVM) Integration

kotlin

import okhttp3.*
import okhttp3.MediaType.Companion.toMediaType
import okhttp3.RequestBody.Companion.toRequestBody

fun executeSyntricQuery() {
    val client = OkHttpClient()
    val mediaType = "application/json; charset=utf-8".toMediaType()
    val body = """{"sql": "SELECT * FROM products WHERE embedding SIMILAR TO 'smartwatch' TOP 3"}""".toRequestBody(mediaType)
    
    val request = Request.Builder()
        .url("http://localhost:8080/api/sql")
        .post(body)
        .build()
        
    client.newCall(request).execute().use { response ->
        println("SyntricDB Kotlin Result: ${response.body?.string()}")
    }
}

💎 Ruby Integration

ruby

require 'net/http'
require 'json'
require 'uri'

uri = URI.parse("http://localhost:8080/api/sql")
header = {'Content-Type': 'application/json'}
body = { sql: "SELECT * FROM products WHERE embedding SIMILAR TO 'mechanical pencil' TOP 3" }

http = Net::HTTP.new(uri.host, uri.port)
request = Net::HTTP::Post.new(uri.request_uri, header)
request.body = body.to_json

response = http.request(request)
puts "SyntricDB Ruby Response: #{response.body}"

🌐 cURL & REST API Documentation

bash

curl -X POST http://localhost:8080/api/sql \
  -H "Content-Type: application/json" \
  -d '{"sql": "SELECT * FROM products WHERE embedding SIMILAR TO '\''wireless keyboard'\'' TOP 3;"}'

The AI-Native Unified Database Engine

SyntricDB Official Product Video

SyntricDB in Action

🎬 Real-Time Interactive Studio Demo

🧠 Unified 6-in-1 Engine Architecture

⚡ SyntricDB vs Traditional DB Sprawl

📈 Sub-Millisecond Vector Benchmark

Built for Modern AI & Production Workloads

HNSW Vector Graph Engine

Java 21 Generational ZGC

Full ACID Transactions

BM25 Full-Text Search

LSM-Tree Core Storage

Distributed Raft Consensus

Try SyntricDB SQL & Vector Commands

Multi-Language Developer Integration Hub

🚀 Quickstart & One-Line Installers

🍏 macOS & Linux Terminal

🪟 Windows 10 / 11 / Server (PowerShell)

🐳 Docker Container

🔑 Default Access Credentials

💻 CLI Utilization Guide (`syntricdb-cli`)

1. Interactive CLI Connection

2. Single Query Execution

📖 Unified SQL & AI Function Reference

Vector Similarity Search

🐍 Official Python Client SDK

💚 Official Node.js / TypeScript Client SDK

☕ Java & Spring Boot JPA Integration

🔷 Go (Golang) Integration

💜 C# / .NET 8 Integration

🦀 Rust Integration

🐘 PHP Integration

🍎 Swift (iOS / macOS) Integration

🤖 Kotlin (Android / JVM) Integration

💎 Ruby Integration

🌐 cURL & REST API Documentation

Download SyntricDB Packages

Python Package

Node.js Package

GitHub Source Code