Get up and running with ShibuDB in minutes
This quick start guide will help you get ShibuDB up and running in just a few minutes. You'll learn how to:
Follow these steps to install ShibuDB:
Download the appropriate package for your platform from the download section.
# Install package
sudo installer -pkg shibudb-{version}-apple_silicon.pkg -target /
# Verify installation
shibudb --version# Start server on port 9090
sudo shibudb start 9090
# Check status
sudo shibudb statusNow let's connect to ShibuDB and create your first space:
# Connect using CLI client
shibudb client localhost:9090
# Login with default credentials
Username: admin
Password: admin# Create a key-value space
CREATE-SPACE my_data --engine key-value
# List all spaces
LIST-SPACES
# Switch to the created space
USE my_dataLearn the basic key-value operations:
# Store a key-value pair
PUT user:1 "John Doe"
PUT user:2 "Jane Smith"
PUT config:theme "dark"
# Retrieve values
GET user:1
GET user:2
GET config:theme
# Delete a key
DELETE user:1
# Check if key exists
EXISTS user:2# Store multiple values
PUT user:3 "Bob Johnson"
PUT user:4 "Alice Brown"
PUT user:5 "Charlie Wilson"
# Get multiple values
GET user:3 user:4 user:5
# Delete multiple keys
DELETE user:3 user:4Explore ShibuDB's powerful vector search capabilities:
# Create a vector space with 128 dimensions
CREATE-SPACE vectors --engine vector --dimension 128
# Switch to vector space
USE vectors# Insert vectors with IDs
INSERT-VECTOR vec1 1.0,2.0,3.0,4.0,5.0,6.0,7.0,8.0
INSERT-VECTOR vec2 2.0,3.0,4.0,5.0,6.0,7.0,8.0,9.0
INSERT-VECTOR vec3 0.5,1.5,2.5,3.5,4.5,5.5,6.5,7.5
# Insert more vectors for search
INSERT-VECTOR vec4 1.1,2.1,3.1,4.1,5.1,6.1,7.1,8.1
INSERT-VECTOR vec5 1.2,2.2,3.2,4.2,5.2,6.2,7.2,8.2# Search for top 3 similar vectors
SEARCH-TOPK 1.0,2.0,3.0,4.0,5.0,6.0,7.0,8.0 3
# Search with different query vector
SEARCH-TOPK 2.0,3.0,4.0,5.0,6.0,7.0,8.0,9.0 5# Get vector by ID
GET-VECTOR vec1
# Delete vector
DELETE-VECTOR vec1
# Count vectors in space
COUNT-VECTORS
# List all vector IDs
LIST-VECTORSCongratulations! You've successfully set up ShibuDB and performed basic operations. Here's what you can explore next: