Class Namespace

Namespace is the class on which CRUD operations can be invoked. The default namespace is the empty string, "". You can create nested namespaces by calling the namespace(prefix) method.

For example, if the current namespace is the default "" and you call namespace('user1/'), all operations on that new namespace will be automatically prefixed with user1/:

const client = new Etcd3();
const ns = client.namespace('user1/');

await ns.put('foo').value('bar'); // sets the key `user1/foo` to `bar`
await ns.delete().all(); // deletes all keys with the prefix `user1/`

Namespacing is particularly useful to avoid clashing between multiple applications and when using Etcd's access control.

Hierarchy (View Summary)

Namespace
- Etcd3

Index

Constructors

constructor

Methods

delete election get getAll if lease lock namespace put range stm watch

Constructors

`Protected`constructor

new Namespace(
    prefix: Buffer,
    pool: ConnectionPool,
    options: IOptions,
): Namespace
Parameters
- prefix: Buffer
- pool: ConnectionPool
- options: IOptions
Returns Namespace
- Defined in src/namespace.ts:58

Methods

delete

delete(): DeleteBuilder
.delete() starts making a delete request against etcd.

Returns DeleteBuilder
- Defined in src/namespace.ts:100

election

election(name: string, ttl?: number): Election
Creates a new Election instead. See more information on the Election class documentation.
Parameters
- name: string
  Name of the election in the etcd instance.
- Optionalttl: number
  Lease TTL used in the election. This is the maximum time that a node which goes down can remain the leader before being automatically evicted.
Returns Election
- Defined in src/namespace.ts:188

get

get(key: string | Buffer<ArrayBufferLike>): SingleRangeBuilder
.get() starts a query to look up a single key from etcd.
Parameters
- key: string | Buffer<ArrayBufferLike>
Returns SingleRangeBuilder
- Defined in src/namespace.ts:79

getAll

getAll(): MultiRangeBuilder
.getAll() starts a query to look up multiple keys from etcd.

Returns MultiRangeBuilder
- Defined in src/namespace.ts:86

if

if(
    key: string | Buffer<ArrayBufferLike>,
    column: "Lease" | "Version" | "Create" | "Mod" | "Value",
    cmp: "==" | "===" | ">" | "<" | "!=" | "!==",
    value: string | number | Buffer<ArrayBufferLike>,
): ComparatorBuilder
if() starts a new etcd transaction, which allows you to execute complex statements atomically. See documentation on the ComparatorBuilder for more information.
Parameters
- key: string | Buffer<ArrayBufferLike>
- column: "Lease" | "Version" | "Create" | "Mod" | "Value"
- cmp: "==" | "===" | ">" | "<" | "!=" | "!=="
- value: string | number | Buffer<ArrayBufferLike>
Returns ComparatorBuilder
- Defined in src/namespace.ts:144

lease

lease(ttl: number, options?: ILeaseOptions): Lease
lease() grants and returns a new Lease instance. The Lease is automatically kept alive for you until it is revoked. See the documentation on the Lease class for some examples.
Parameters
- ttl: number
- Optionaloptions: ILeaseOptions
Returns Lease
- Defined in src/namespace.ts:109

lock

lock(key: string | Buffer<ArrayBufferLike>): Lock
lock() is a helper to provide distributed locking capability. See the documentation on the Lock class for more information and examples.
Parameters
- key: string | Buffer<ArrayBufferLike>
Returns Lock
- Defined in src/namespace.ts:117

namespace

namespace(prefix: string | Buffer<ArrayBufferLike>): Namespace
namespace adds a prefix and returns a new Namespace, which is used for operating on keys in a prefixed domain. For example, if the current namespace is the default "" and you call namespace('user1/'), all operations on that new namespace will be automatically prefixed with user1/. See the Namespace class for more details.
Parameters
- prefix: string | Buffer<ArrayBufferLike>
Returns Namespace
- Defined in src/namespace.ts:176

put

put(key: string | Buffer<ArrayBufferLike>): PutBuilder
.put() starts making a put request against etcd.
Parameters
- key: string | Buffer<ArrayBufferLike>
Returns PutBuilder
- Defined in src/namespace.ts:93

range

range(r: Rangable): Range
Creates a structure representing an etcd range. Used in permission grants and queries. This is a convenience method for Etcd3.Range.from(...).
Parameters
- r: Rangable
Returns Range
- Defined in src/namespace.ts:165

stm

stm(options?: Partial<ISTMOptions>): SoftwareTransaction
stm() creates a new software transaction, see more details about how this works and why you might find this useful on the SoftwareTransaction class.
Parameters
- Optionaloptions: Partial<ISTMOptions>
Returns SoftwareTransaction
- Defined in src/namespace.ts:126

watch

watch(): WatchBuilder
.watch() creates a new watch builder. See the documentation on the WatchBuilder for usage examples.

Returns WatchBuilder
- Defined in src/namespace.ts:157

Class Namespace

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

Protectedconstructor

Parameters

Returns Namespace

Methods

delete

Returns DeleteBuilder

election

Parameters

Returns Election

get

Parameters

Returns SingleRangeBuilder

getAll

Returns MultiRangeBuilder

if

Parameters

Returns ComparatorBuilder

lease

Parameters

Returns Lease

lock

Parameters

Returns Lock

namespace

Parameters

Returns Namespace

put

Parameters

Returns PutBuilder

range

Parameters

Returns Range

stm

Parameters

Returns SoftwareTransaction

watch

Returns WatchBuilder

Settings

On This Page

`Protected`constructor