Connect to Database

Once you have installed the driver and set up an Ultipa instance, you can connect your application to the database.

Create a Connection

Creates a connection by instantiating UltipaDriver() with an ULTIPA.UltipaConfig object, which holds the configuration details required to connect to the database.

See more connection configuration options →

import { UltipaDriver } from "@ultipa-graph/ultipa-driver";
import type { ULTIPA } from "@ultipa-graph/ultipa-driver/dist/types/index.js";

let sdkUsage = async () => {
  const ultipaConfig: ULTIPA.UltipaConfig = {
    // URI example: hosts: ["xxxx.us-east-1.cloud.ultipa.com:60010"]
    hosts: ["10.xx.xx.xx:60010"],
    username: "<username>",
    password: "<password>"
  };

  const driver = new UltipaDriver(ultipaConfig);
  
  // Tests the connection
  const isSuccess = await driver.test();
  console.log(`Connection succeeds: ${isSuccess}`);
};

sdkUsage().catch(console.error);

Connection succeeds: true

Use Configuration File

This example demonstrates how to use the configuration file .env to establish a connection:

import { UltipaDriver } from "@ultipa-graph/ultipa-driver";
import type { ULTIPA } from "@ultipa-graph/ultipa-driver/dist/types/index.js";
import * as dotenv from "dotenv";

// Loads the .env file and overrides system environment variables
dotenv.config({override:true});

const hosts = process.env.hosts?.split(',') || [];
const username = process.env.username!;
const password = process.env.password!;

const sdkUsage = async () => {
  const ultipaConfig: ULTIPA.UltipaConfig = {
    hosts: hosts,
    username: username,
    password: password,
  };

  const conn = new UltipaDriver(ultipaConfig);

  // Tests the connection
  const isSuccess = await conn.test();
  console.log(`Connection succeeds: ${isSuccess}`);
};

sdkUsage().catch(console.error);

Connection succeeds: true

Example of the .env file:

// hosts=xxxx.us-east-1.cloud.ultipa.com:60010
hosts=10.xx.xx.xx:60010
username=<username>
password=<password>
passwordEncrypt=MD5
defaultGraph=miniCircle
// crt=F:\\ultipa.crt
// maxRecvSize=10240

See more connection configuration options →

Connection Configuration

UltipaConfig or a configuration file can include the following fields: