Skip to content

Commit 0bd6d13

Browse files
docs: update migration guide with v2.1 changes
Add sections for UpdateRequest skyflowId preference, updateLogLevel and getBYOT deprecations. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 3504d72 commit 0bd6d13

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

docs/migrate_to_v2.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -249,4 +249,35 @@ Response maps now return `skyflowId` (camelCase). The legacy `skyflow_id` key is
249249

250250
---
251251

252+
## Update request data key (v2.1+)
253+
254+
When calling `update()`, use `skyflowId` (camelCase) as the key in the data map to identify the record. Using `skyflow_id` still works but emits a deprecation warning. If both keys are present, `skyflowId` takes precedence.
255+
256+
```java
257+
HashMap<String, Object> data = new HashMap<>();
258+
data.put("skyflowId", "<SKYFLOW_ID>"); // preferred
259+
data.put("card_number", "<NEW_VALUE>");
260+
261+
UpdateRequest request = UpdateRequest.builder()
262+
.table("<TABLE_NAME>")
263+
.data(data)
264+
.returnTokens(true)
265+
.build();
266+
267+
skyflowClient.vault().update(request);
268+
```
269+
270+
---
271+
272+
## Method renames (v2.1+)
273+
274+
The following instance methods have been renamed for consistency. The old names still work but emit deprecation warnings.
275+
276+
| Deprecated | Preferred |
277+
|---|---|
278+
| `skyflowClient.updateLogLevel(logLevel)` | `skyflowClient.setLogLevel(logLevel)` |
279+
| `TokenMode.getBYOT()` | `TokenMode.getByot()` |
280+
281+
---
282+
252283
For the full list of changes see [CHANGELOG.md](../CHANGELOG.md).

0 commit comments

Comments
 (0)