website logo
⌘K
🏠Homepage
👋Introduction
Key Concepts & Architecture
🚀Getting Started
👨‍💻SQL Reference
SQL Queries
SQL Clauses
SQL Data Types
SQL Functions
Schema
🚨Error Handling
🆚Differences Between Oxla vs. PostgreSQL
Docs powered by archbee 

Getting Started

11min

Deploy Oxla in minutes! 🎊

Over the following steps, we'll set you up with an Oxla server so you can see how easy it is to access. Let's get started!

Prerequisite

⚠️ Install Docker. Please refer to this page for further details.

⚠️ We recommend you to use Linux OS computer to deploy an Oxla server

⚠️ Install PostgreSQL on your local machine. Please refer to this page.

Installation Steps

1) Open your terminal and execute this command to check if you have installed your docker properly:

Command
|
docker ps


Note: If it returns “Bad response from Docker engine”, this means there is an issue with your docker engine. Try re-install your docker.

2) Execute the following command to create a file that contains docker compose file:

Command
|
vim one_node.yml


Option 1 - Run Oxla against data in your local machine

3) If you want to run Oxla using data in your local machine, input the following code into the docker compose file:

TypeScript
|
version: '3.5'
volumes:
  oxla_data:
services:
  oxla_node:
    image: public.ecr.aws/oxla/release:2023.5.0-Release-x86_64
    security_opt:
      - seccomp:unconfined
    ulimits:
      nofile:
        soft: 40000
        hard: 40000
    volumes:
      - oxla_data:/data
    ports:
      - 5432:5432
    environment:
      - OXLA_HOME=${OXLA_HOME-/data}



Note: To save, don't forget to enter :wq



Option 2 - Run Oxla against data in S3

3) If you want to run Oxla using data in S3, input the following code into the docker compose file:

Command
|
version: '3.5'
volumes:
  oxla_data:
services:
  oxla_node:
    image: public.ecr.aws/oxla/release:2023.2.1-Release-x86_64
    security_opt:
      - seccomp:unconfined
    ulimits:
      nofile:
        soft: 40000
        hard: 40000
    volumes:
      - oxla_data:/data
    ports:
      - 5432:5432
    environment:
      - OXLA_HOME=s3://yourdirectoryname
      - AWS_DEFAULT_REGION=AWS_DEFAULT_REGION
      - AWS_ACCESS_KEY_ID=AWS_ACCESS_KEY_ID
      - AWS_SECRET_ACCESS_KEY=AWS_SECRET_ACCESS_KEY



Note: Don’t forget to replace the s3, AWS_DEFAULT_REGION, AWS_ACCESS_KEY_ID, and AWS_SECRET_ACCESS_KEY with appropriate values.

4) Execute the following command to create and start the docker container:

TypeScript
|
docker compose -f one_node.yml up


5) Execute the following command to run Oxla:

TypeScript
|
psql -h localhost


Note: If you encounter an error response “bash: psql: command not found“, this means that you have not installed PostgreSQL.

When you get the following result, you are now in the Oxla server✅

TypeScript
|
psql (14.4, server Oxla 1.0)

HP=>


🚧 Encountered an error? We got you! Head over here to see your troubleshooting resolutions!



Updated 30 May 2023
Did this page help you?
Yes
No
PREVIOUS
Our Key Features
NEXT
SQL Reference
Docs powered by archbee 
TABLE OF CONTENTS
Prerequisite
Installation Steps

Dedicated to data analytics that provides 10x faster execution of analytical queries than current state of the art solutions. We are launching SOON! Join the waiting list for more info.




©2022 Oxla