Getting started

Here we will guide you through the process of accessing your HIDDB database.

Installation

Use one of our client SDKs or our REST API. To install the corresponding SDK execute one of the following commands.

npm
yarn
pip

npm install --save-dev hiddb

yarn add hiddb

pip install --user hiddb

Then, depending on your preferred programming language, type the following:

TypeScript
JavaScript
Python
cURL

import { HIDDB } from 'hiddb';

async function main() {
    // Create client ant login
    const hiddb = new HIDDB();
    
    // Get a list of your collections
    await hiddb.listCollections("<database_id>")
}

const { HIDDB } = require('hiddb');

async function main() {
    // Create client ant login
    const hiddb = new HIDDB();
    
    // Get a list of your collections
    await hiddb.listCollections("<database_id>")
}

from hiddb.synchronous import HIDDB

# Get a list of your collections
hiddb.get_collection(
    database_id="<database_id>", collection_name="<collection_name>"
)

# Get collections
curl --location \
     --request GET "https://<database_url>/collection" \
     --header "Accept: application/json" \

Congratulations! 🎉 You just successfully accessed your database.

Installation​

Installation