Skip to content

README.md

Latest commit

 

History

History
58 lines (44 loc) · 2.45 KB

README.md

File metadata and controls

58 lines (44 loc) · 2.45 KB
Raw

FlowVault Python samples

Runnable examples for the skyflow-flowvault-python SDK — one file per operation. See the flowvault README for the full SDK guide.

Prerequisites

  • Python 3.9+
  • pip install skyflow-flowvault-python
  • A FlowVault vault and Skyflow credentials (a service-account credentials.json, an API key, or a bearer token).

Configure

Each sample has placeholders near the top — replace them with your own values:

credentials = {'path': '<PATH_TO_YOUR_CREDENTIALS_JSON>'}   # or 'api_key' / 'token' / 'credentials_string'
vault_config = {
    'vault_id': '<YOUR_VAULT_ID>',
    'cluster_id': '<YOUR_CLUSTER_ID>',
    'env': Env.PROD,
    'credentials': credentials,
}

Run

python flowvault/samples/vault_api/insert_records.py

Vault operations

Sample Demonstrates
insert_records.py Insert records (request-level and per-record table_name/upsert)
get_records.py Retrieve records by Skyflow ID
update_record.py Update a record
delete_records.py Delete records
detokenize_records.py Detokenize tokens

Custom headers & HTTP config

Sample Demonstrates
custom_header_example.py Attach custom headers via an InsertOptions interceptor (CustomHeaderKey)
timeout_and_retry_config_example.py Per-vault timeout and max_retries config keys

Service account (token generation)

Sample Demonstrates
bearer_token_generation_example.py Bearer token from a credentials file path or a credentials string
bearer_token_generation_with_context_example.py Context-aware bearer tokens (string context and dict context)
bearer_token_generation_using_threads_example.py Multithreaded token generation with a shared context
scoped_token_generation_example.py Scoped tokens via role_ids
signed_token_generation_example.py Signed data tokens (generate_signed_data_tokens)