@ultipa-graph/ultipa-driver/readme.md

NodeJS SDK for ultipa-server 5.2

# Ultipa NodeJS SDK

## Introduction

This Node.js SDK is a part of Ultipa Drivers, a set of specifications for developing software and applications using Java, Python, Go, C# and Node.js. It enables the integration of query and management operations from the Ultipa Graph Database into Node.js programs. Developers can interact with the database either by invoking predefined interface methods or by sending assembled UQL (Ultipa Query Language) or GQL (Graph Query Language) queries directly to an Ultipa server. A basic understanding of UQL/GQL syntax and the returned data structures is needed for effective use of the SDK.

## Installation

```bash
npm install @ultipa-graph/ultipa-driver
```

## Document

For more details, please visit [Ultipa Node.js SDK Guide (v5.0)](https://www.ultipa.com/document/ultipa-drivers/nodejs-installation/v5.0).

If you have any questions, feel free to reach out to [Ultipa Support](mailto:support@ultipa.com)

## Usage

### Establish Connection

`UltipaConfig` defines the configuration details required by `UltipaDriver` to establish a connection with an Ultipa graph database.

```ts

import { UltipaConfig, UltipaDriver } from "@ultipa-graph/ultipa-driver";

let sdkUsage = async () => {
  let ultipaConfig = new UltipaConfig()

  ultipaConfig.hosts = [
    "192.168.1.1:60061",
    "192.168.1.2:60061",
    "192.168.1.3:60061"
  ];
  ultipaConfig.username = "***";
  ultipaConfig.password = "***";
  ultipaConfig.defaultGraph = "miniCircle";

  let driver = new UltipaDriver(ultipaConfig);
  let isSuccess = await driver.test();

  console.log(isSuccess);

};

sdkUsage().then(console.log).catch(console.log);

```

### Send UQL

```ts
import { UltipaConfig, UltipaDriver } from "@ultipa-graph/ultipa-driver";

let sdkUsage = async () => {

  // Assume 'driver' is already initialized and connected
  let resp = await driver.uql("show().graph()");
  console.log(resp);
};

sdkUsage();
```