logo

Getting Started

This is the getting started page.

Getting Started with VortexDB

This guide will walk you through the process of setting up VortexDB and running your first queries. We'll cover installation, configuration, and basic operations.

Installation

VortexDB can be installed on a variety of platforms. The easiest way to get started is with Docker:

docker run -p 8080:8080 vortexdb/vortexdb:latest

For other installation methods, please refer to the full installation guide.

Connecting to VortexDB

Once VortexDB is running, you can connect to it using our SDKs. Here's an example using our JavaScript SDK:

import { VortexDB } from 'vortexdb-js';

const db = new VortexDB({
  endpoint: 'http://localhost:8080',
});

async function main() {
  const result = await db.query('SELECT * FROM users');
  console.log(result);
}

main();

Creating Your First Table

Let's create a simple table to store user data:

CREATE TABLE users (
  id INT PRIMARY KEY,
  name VARCHAR(255),
  email VARCHAR(255)
);

Inserting Data

Now, let's insert some data into our new table:

INSERT INTO users (id, name, email) VALUES (1, 'John Doe', 'john.doe@example.com');

Querying Data

Finally, let's query the data we just inserted:

SELECT * FROM users;

This should return the following result:

id name email
1 John Doe john.doe@example.com
On this page