Skip to content

docs: SK-3225: Fix FlowVault Node SDK README retry defaults and vault host #351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
promptless wants to merge 1 commit into
base: flowvault-release/26.9.0
Choose a base branch
from
Open

docs: SK-3225: Fix FlowVault Node SDK README retry defaults and vault host #351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

Securely handle sensitive data at rest, in-transit, and in-use with the Skyflow SDK for Node.js, Deno, Bun, and Cloudflare Workers.

> **Using a Flow DB vault?** This README covers the `skyflow-node` package. For FlowVault, install `skyflow-flowvault-node` instead and follow the [FlowVault Node SDK README](flowvault/README.md). Install only one of the two packages.
Comment thread
promptless[bot] marked this conversation as resolved.

[![CI](https://img.shields.io/static/v1?label=CI&message=passing&color=green?style=plastic&logo=github)](https://github.com/skyflowapi/skyflow-node/actions)
[![GitHub release](https://badge.fury.io/js/skyflow-node.svg)](https://www.npmjs.com/package/skyflow-node)
[![License](https://img.shields.io/github/license/skyflowapi/skyflow-node)](https://github.com/skyflowapi/skyflow-node/blob/main/LICENSE)
Expand Down
7 changes: 4 additions & 3 deletions flowvault/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ detokenize, tokenize, and attach files to records in a Flow DB vault.
- [Initialize the client](#initialize-the-client)
- [Vault operations](#vault-operations)
- [Custom request headers](#custom-request-headers)
- [Timeouts and retries](#timeouts-and-retries)
- [Error handling](#error-handling)
- [Samples](#samples)
- [License](#license)
Expand Down Expand Up @@ -45,7 +46,7 @@ import { Skyflow, InsertRequest, Env, LogLevel, SkyflowError } from 'skyflow-flo
const skyflowClient = new Skyflow({
vaultConfigs: [{
vaultId: 'your-vault-id',
clusterId: 'your-cluster-id', // from the vault URL: https://{clusterId}.vault.skyflowapis.com
clusterId: 'your-cluster-id', // from the vault URL: https://{clusterId}.skyvault.skyflowapis.com
Comment thread
promptless[bot] marked this conversation as resolved.
env: Env.PROD, // DEV, STAGE, SANDBOX, or PROD
credentials: { token: 'your-bearer-token' },
}],
Expand Down Expand Up @@ -294,8 +295,8 @@ const skyflowClient = new Skyflow({
vaultId: 'vault-id',
clusterId: 'cluster-id',
credentials: { token: 'bearer-token' },
timeout: 30, // overall per-call timeout in seconds (incl. retries). Default 60.
maxRetries: 2, // retry attempts after the first failure (408/429/5xx). Default off.
timeout: 30, // timeout in seconds for each attempt, applied again to each retry. Default 60.
Comment thread
promptless[bot] marked this conversation as resolved.
maxRetries: 2, // retry attempts after the first failure (408/429/5xx). Default 2; 0 turns retries off.
Comment thread
promptless[bot] marked this conversation as resolved.
vaultUrl: 'https://cluster-id.skyvault.skyflowapis.com', // optional — override the derived URL
}],
});
Expand Down
2 changes: 1 addition & 1 deletion flowvault/samples/vault-api/insert-records.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ async function performSecureDataInsertion(): Promise<void> {
vaultConfigs: [
{
vaultId: '<YOUR_VAULT_ID>',
clusterId: '<YOUR_CLUSTER_ID>', // from the vault URL: https://{clusterId}.vault.skyflowapis.com
clusterId: '<YOUR_CLUSTER_ID>', // from the vault URL: https://{clusterId}.skyvault.skyflowapis.com
Comment thread
promptless[bot] marked this conversation as resolved.
env: Env.PROD, // DEV, STAGE, SANDBOX, or PROD
credentials,
},
Expand Down
4 changes: 2 additions & 2 deletions flowvault/samples/vault-api/timeout-and-retry-config-example.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ import {
*
* The flowvault SDK honors these VaultConfig fields (applied to the generated
* client's request layer at client construction):
* timeout overall per-call timeout in seconds, incl. retries + backoff. Default 60.
* maxRetries retry attempts after the first failure (408/429/5xx). Default off.
* timeout timeout in seconds for each attempt, applied again to each retry. Default 60.
Comment thread
promptless[bot] marked this conversation as resolved.
* maxRetries retry attempts after the first failure (408/429/5xx). Default 2; 0 turns retries off.
* vaultUrl override the vault URL derived from clusterId/env.
*
* NOTE: the finer-grained connect/read/write timeouts and retry-delay knobs from
Expand Down