Getting Started
Welcome to NexaDB! Let's get you started with your first database operations.
š¦ Haven't Installed Yet?
Choose your platform and get NexaDB running in minutes:
View Installation Guides āStep 1: Start NexaDB Server
After installation, start all three services with one command:
$nexadb start
ā Binary Protocol on port 6970 (10x faster!)
ā JSON API on port 6969 (REST fallback)
ā Admin UI on port 9999 (Web interface)
š One Command, Three Servers!
The nexadb start command launches all three services simultaneously:
- ⢠Binary Protocol (6970) - 10x faster performance for production workloads
- ⢠JSON REST API (6969) - HTTP fallback for easy integration
- ⢠Admin Web UI (9999) - Beautiful interface for database management
- ⢠All services share the same data directory for consistency
- ⢠Graceful shutdown with Ctrl+C kills all processes cleanly
Step 2: Access the Admin Panel
The admin panel is already running! Simply open your browser and visit:
Admin Panel URL
Default Admin Credentials
Username: root
Password: nexadb123
ā ļø IMPORTANT: Change the default password after first login!
Admin Panel Features
- ⢠š View and manage collections
- ⢠š Create, edit, and delete documents
- ⢠šļø Bulk delete with confirmation
- ⢠š„ Manage users and roles
- ⢠š Generate and manage API keys
- ⢠š Paginated document browsing
Password Reset
If you forget your password, reset it easily:
$ nexadb reset-password
This resets the root password to the default (nexadb123) without losing any data.
Step 3: Try the Interactive CLI
Use the nexa CLI for MySQL-like terminal access:
$ nexa -u root -p
Password: ********
Connected to NexaDB v2.2.0 (Binary Protocol: localhost:6970)
nexa> collections
ā No collections found
nexa> help
Available commands:
collections - List all collections
use <name> - Switch to a collection
insert <json> - Insert a document
read <id> - Read a document by ID
update <id> <json> - Update a document
delete <id> - Delete a document
query <json> - Query documents
count - Count documents in collection
help - Show this help message
exit - Exit nexa CLI⨠Why Use nexa CLI?
- ⢠Zero dependencies - Standalone Rust binary
- ⢠10x faster - Uses MessagePack binary protocol
- ⢠MySQL-like - Familiar command-line interface
- ⢠Full-featured - All database operations supported
Step 4: Install a Client Library
Connect to NexaDB from your application using our client libraries:
JavaScript/Node.js
npm
npm install nexaclient
Python
pip
pip install nexaclient
What's Next?
Now that you're set up, dive deeper into NexaDB: