Client

Overview

Module

• package: @aerokit/sdk/etcd
• source: etcd/client.ts
• last updated:

This module provides a Client class for interacting with the Etcd key-value store within the Dirigible environment. The Client class allows developers to perform basic operations such as putting (writing) values, getting values, and deleting keys in Etcd. It also includes utility functions for converting between JavaScript types and the native Java/Etcd types used by the underlying Etcd client library.

Key Features

• Put string or byte array values to Etcd keys.
• Get values from Etcd keys with options for string or byte array formats.
• Retrieve metadata about the Etcd cluster and key-value store through response headers.
• Delete keys from Etcd.

Use Cases

• Storing configuration data or application state in Etcd for distributed applications.
• Retrieving and managing key-value pairs in Etcd for service discovery, configuration management, or coordination tasks.
• Integrating with other modules that require a consistent interface for interacting with Etcd as a backend store.

Example Usage

import { Client } from "@aerokit/sdk/etcd";

const etcdClient = new Client();

// Put a string value to a key
etcdClient.putStringValue("config/appName", "MyApp");

// Get the string value of a key
const appName = etcdClient.getKvsStringValue("config/appName");
console.log(appName); // Output: { "config/appName": "MyApp" }

// Delete a key
etcdClient.delete("config/appName");

Classes

Header

getRevision()

The revision of the key-value store when the request was processed.

getRevision(): string;

Returns

• Type: string
• Description:

getClusterId()

The ID of the cluster which the request was sent to.

getClusterId(): string;

Returns

• Type: string
• Description:

getMemberId()

The ID of the member which the request was handled by.

getMemberId(): string;

Returns

• Type: string
• Description:

getRaftTerm()

The Raft term.

getRaftTerm(): string;

Returns

• Type: string
• Description:

GetResponse

getHeader()

Retrieves the response header containing cluster metadata.

getHeader(): Header;

Returns

• Type: Header
• Description:

getKvsString()

Retrieves the Key-Value pairs with values converted to strings.

getKvsString(): void;

Returns

• Type: void
• Description:

getKvsByteArray()

Retrieves the Key-Value pairs with values converted to Int8Array (byte arrays).

getKvsByteArray(): void;

Returns

• Type: void
• Description:

getCount()

Retrieves the number of Key-Value pairs returned.

getCount(): number;

Returns

• Type: number
• Description:

Client

putStringValue()

Puts (writes) a string value to the specified key.

putStringValue(key: string, value: string): void;

Parameter	Type	Description
key	string	The key to write to.
value	string	The string value.

Returns

• Type: void
• Description:

putByteArrayValue()

Puts (writes) a byte array value to the specified key.

putByteArrayValue(key: string, value: Int8Array): void;

Parameter	Type	Description
key	string	The key to write to.
value	Int8Array	The Int8Array (byte array) value.

Returns

• Type: void
• Description:

getHeader()

Retrieves the response header metadata for a key.

getHeader(key: string): Header;

Parameter	Type	Description
key	string	The key to query.

Returns

• Type: Header
• Description: The Header object.

getKvsStringValue()

Retrieves the Key-Value pairs as a JavaScript object with string values.

getKvsStringValue(key: string): void;

Parameter	Type	Description
key	string	The key (or key prefix) to query.

Returns

• Type: void
• Description: An object mapping keys to string values.

getKvsByteArrayValue()

Retrieves the Key-Value pairs as a JavaScript object with Int8Array values.

getKvsByteArrayValue(key: string): void;

Parameter	Type	Description
key	string	The key (or key prefix) to query.

Returns

• Type: void
• Description: An object mapping keys to Int8Array values.

getCount()

Retrieves the count of Key-Value pairs matching the key (or key prefix).

getCount(key: string): number;

Parameter	Type	Description
key	string	The key (or key prefix) to query.

Returns

• Type: number
• Description: The count of matching entries.

delete()

Deletes the specified key.

delete(key: string): void;

Parameter	Type	Description
key	string	The key to delete.

Returns

• Type: void
• Description: