## Example

This example highlights the common operations for the Stash service using the Stedi SDK for JavaScript.

### Setup

Install the SDK with `npm install -g @stedi/sdk-client-stash`. Ensure you have created a [Stedi API Key](/docs/accounts-and-billing/authentication).

```javascript
const { StashClient } = require("@stedi/sdk-client-stash");

const client = new StashClient({
  region: "us",
  apiKey: "<replace with Stedi API key>",
});
```

### Creating a Keyspace

In order to store keys and values, we need to create a Keyspace. We may use a single Keyspace for different
situations, as long as we ensure that the keys will not overwrite one another.

```javascript
const { CreateKeyspaceCommand } = require("@stedi/sdk-client-stash");

try {
  const output = await client.send(
    new CreateKeyspaceCommand({
      keyspaceName: "my-keyspace",
    })
  );
  console.log(`Keyspace status is ${output.status}`);
} catch (e) {
  throw e;
}
```

*Note:* It may take a few seconds for a Keyspace to be ready to use. You can use the `GetKeyspace` operation
to determine if it is in the `ACTIVE` state.

### Storing Values

This snippet just stores a simple item where the Key is `foo` and the Value is `bar`. Note how we use the same Keyspace name as used in the previous step.

```javascript
const { SetValueCommand } = require("@stedi/sdk-client-stash");

  const rl = readline.createInterface({
    input: fileStream,
    crlfDelay: Infinity,
  });

  for await (const line of rl) {
    item = JSON.parse(line);
    const url = baseUrl + "/SetValue";
    const payload = {
      keyspace: keyspaceName,
      key: `${item.vendor_id}|${item.vendor_sku}`,
      value: item.internal_sku,
    };
    await axios
      .post(url, payload, config)
      .then((resp) => {
        console.log(`Stored key=${payload.key}, value=${payload.value}`);
      })
      .catch((e) => {
        console.log(`Error setting value: ${e}`);
        process.exit(1);
      });
  }
}
```

### Retrieving Values

Simply use the `GetValue` operation to retrieve any values.

```javascript
const { GetValueCommand } = require("@stedi/sdk-client-stash");

try {
  const output = await client.send(
    new GetValueCommand({
      keyspaceName: "my-keyspace",
      key: "foo",
    })
  );
  console.log(`Retrieved key=${output.key}, value=${output.value}`);
} catch (e) {
  console.error(e);
}
```

### Incrementing Numbers

The `IncrementValue` operation will atomically increment a number by the `amount` specified. If the key does not exist, it will be initialized with 0. If the key exists and is not a number, this results in a `ValidationError` error.

```javascript
const { IncrementValueCommand } = require("@stedi/sdk-client-stash");

try {
  const output = await client.send(
    new IncrementValueCommand({
      keyspaceName: "my-keyspace",
      key: "invoice-number",
      amount: 1,
    })
  );
  console.log(`Incremented key=${output.key}, value=${output.value}`);
} catch (e) {
  console.error(e);
}
```


A Keyspace is a way to group key-value pairs together for organization
or retrieval purposes. All Keys within a Keyspace are unique, and
therefore any Value that gets stored with a Key could override
any previous Value that may have been stored with the same Key.

Keyspaces may take a few seconds to be fully created, as shown in
the `status` field of the response.

Stash API specification.

For more information, read the [Getting Started Guide](/docs/stash).

All API endpoints are POST operations and any parameters
must be fully contained in the request body.

Stash

Create a new Keyspace. Keyspace names are unique to a Stedi account.

Delete a value in a table. This operation also returns the value
as it existed in the moment before it was deleted.

Get a Value from a Keyspace. Always returns the latest
Value that has been stored.
Empty object is returned when the given key does not exist.

Increment a value.

Increment treats the initial value as 0 if no value exists for the key.
Increment adds the given amount to the value.
An error is thrown if the value exists and is not a number.

Set a Value in a Keyspace.

This operation will overwrite any previous Values that have been stored in
the same Key.

JavaScript Example

Example

Setup

Creating a Keyspace

Storing Values

Retrieving Values

Incrementing Numbers

Feedback