Python SDK: Migrate from V1 to V2

1
def token_provider():
2
    global bearer_token
3
    if not is_expired(bearer_token):
4
        return bearer_token
5
    bearer_token, _ = generate_bearer_token('<YOUR_CREDENTIALS_FILE_PATH>')
6
    return bearer_token

1
# Option 1: API key (recommended)
2
credentials = {
3
    'api_key': '<YOUR_API_KEY>',
4
}
5
6
# Option 2: Environment variable — set SKYFLOW_CREDENTIALS in your environment
7
8
# Option 3: Credentials file
9
credentials = {
10
    'path': '<PATH_TO_CREDENTIALS_JSON>',
11
}
12
13
# Option 4: Stringified JSON
14
credentials = {
15
    'credentials_string': '<YOUR_CREDENTIALS_STRING>',
16
}
17
18
# Option 5: Bearer token
19
credentials = {
20
    'token': '<YOUR_BEARER_TOKEN>',
21
}

1
config = Configuration('<VAULT_ID>', '<VAULT_URL>', token_provider)
2
client = Client(config)

1
from skyflow import Skyflow, Env, LogLevel
2
3
skyflow_client = (
4
    Skyflow.builder()
5
    .add_vault_config({
6
        'vault_id': '<VAULT_ID>',
7
        'cluster_id': '<CLUSTER_ID>', # ID from your vault URL, e.g., https://{clusterId}.vault.skyflowapis.com
8
        'env': Env.PROD,
9
        'credentials': credentials,
10
    })
11
    .add_skyflow_credentials(credentials) # Used as a fallback if no per-vault credentials are set
12
    .set_log_level(LogLevel.INFO)
13
    .build()
14
)

1
skyflow_client = (
2
    Skyflow.builder()
3
    .add_vault_config({
4
        'vault_id': '<PRIMARY_VAULT_ID>',
5
        'cluster_id': '<PRIMARY_CLUSTER_ID>',
6
        'env': Env.PROD,
7
        'credentials': primary_credentials,
8
    })
9
    .add_vault_config({
10
        'vault_id': '<SECONDARY_VAULT_ID>',
11
        'cluster_id': '<SECONDARY_CLUSTER_ID>',
12
        'env': Env.PROD,
13
        'credentials': secondary_credentials,
14
    })
15
    .set_log_level(LogLevel.INFO)
16
    .build()
17
)

1
client.insert(
2
    {
3
        "records": [
4
            {
5
                "table": "cards",
6
                "fields": {
7
                    "cardNumber": "41111111111",
8
                    "cvv": "123",
9
                },
10
            }
11
        ]
12
    },
13
    InsertOptions(True),
14
)

1
from skyflow.vault.data import InsertRequest
2
3
insert_data = [
4
    {
5
        'card_number': '<VALUE1>',
6
        'cvv': '<VALUE2>',
7
    },
8
]
9
10
insert_request = InsertRequest(
11
    table='<SENSITIVE_DATA_TABLE>',
12
    values=insert_data,
13
    return_tokens=True,
14
    continue_on_error=True,
15
)
16
17
response = skyflow_client.vault('<VAULT_ID>').insert(insert_request)

1
InsertResponse(
2
    inserted_fields=[
3
        {
4
            'skyflow_id': 'a8f3ed5d-55eb-4f32-bf7e-2dbf4b9d9097',
5
            'card_number': '5479-4229-4622-1393',
6
        }
7
    ],
8
    errors=[],
9
)

1
from skyflow.vault.data import GetRequest
2
3
get_request = GetRequest(
4
    table='<TABLE_NAME>',
5
    ids=['<SKYFLOW_ID_1>', '<SKYFLOW_ID_2>'],
6
    return_tokens=True,
7
)
8
response = skyflow_client.vault('<VAULT_ID>').get(get_request)

1
from skyflow.vault.data import UpdateRequest
2
3
update_request = UpdateRequest(
4
    table='<TABLE_NAME>',
5
    data={
6
        'skyflow_id': '<SKYFLOW_ID>',
7
        'card_number': '<NEW_VALUE>',
8
    },
9
    return_tokens=True,
10
)
11
response = skyflow_client.vault('<VAULT_ID>').update(update_request)

1
from skyflow.vault.data import DeleteRequest
2
3
delete_request = DeleteRequest(
4
    table='<TABLE_NAME>',
5
    ids=['<SKYFLOW_ID_1>', '<SKYFLOW_ID_2>'],
6
)
7
response = skyflow_client.vault('<VAULT_ID>').delete(delete_request)

1
from skyflow.vault.tokens import DetokenizeRequest
2
3
detokenize_request = DetokenizeRequest(
4
    tokens=['<TOKEN_1>', '<TOKEN_2>'],
5
)
6
response = skyflow_client.vault('<VAULT_ID>').detokenize(detokenize_request)

1
from skyflow.vault.data import QueryRequest
2
3
query_request = QueryRequest(
4
    query='SELECT * FROM <TABLE_NAME> WHERE skyflow_id = "<SKYFLOW_ID>"',
5
)
6
response = skyflow_client.vault('<VAULT_ID>').query(query_request)

1
options = InsertOptions(
2
    tokens=True,
3
)

1
from skyflow.utils.enums import TokenMode
2
3
insert_request = InsertRequest(
4
    table='<TABLE_NAME>',
5
    values=insert_data,
6
    return_tokens=False,        # Do not return tokens
7
    continue_on_error=False,    # Stop inserting if any record fails
8
    upsert='<UPSERT_COLUMN>',   # Column used for upsert logic, if any
9
    token_mode=TokenMode.ENABLE,
10
    tokens='<TOKENS>',          # Required when token_mode is ENABLE
11
)

1
{
2
    "http_status": "<http_status>",
3
    "grpc_code": "<grpc_code>",
4
    "http_code": "<http_code>",
5
    "message": "<message>",
6
    "request_id": "<request_id>",
7
    "details": ["<details>"]
8
}

1
from skyflow.vault.tokens import DetokenizeRequest
2
from skyflow.utils.enums import RedactionType
3
4
# Preferred (v2.1+)
5
detokenize_request = DetokenizeRequest(
6
    tokens=['<TOKEN>'],
7
    redaction_type=RedactionType.PLAIN_TEXT,
8
)

1
from skyflow.vault.data import FileUploadRequest
2
3
# Preferred (v2.1+)
4
file_upload_request = FileUploadRequest(
5
    table='<TABLE_NAME>',
6
    skyflow_id='<SKYFLOW_ID>',
7
    column_name='<COLUMN_NAME>',
8
    file_path='<PATH_TO_FILE>',
9
)