From ebb507496b70ceb228e88ea16207f63538bc4e88 Mon Sep 17 00:00:00 2001 From: Aadarsh Date: Wed, 27 May 2026 16:03:33 +0530 Subject: [PATCH 1/4] SK-2848: Updated sdk version --- commonutils/go.mod | 2 ++ docs/migrate_to_v2.md | 16 +++++++++++++++- serviceaccount/go.mod | 2 ++ skyflow/common/common.go | 2 +- skyflow/go.mod | 2 ++ 5 files changed, 22 insertions(+), 2 deletions(-) diff --git a/commonutils/go.mod b/commonutils/go.mod index 90730bbb..2655a0b2 100644 --- a/commonutils/go.mod +++ b/commonutils/go.mod @@ -1,3 +1,5 @@ +// Deprecated: skyflow-go v1.x is deprecated and will reach End of Life on October 31, 2026. Please migrate to v2: https://github.com/skyflowapi/skyflow-go/blob/main/docs/migrate_to_v2.md + module github.com/skyflowapi/skyflow-go/commonutils go 1.18 diff --git a/docs/migrate_to_v2.md b/docs/migrate_to_v2.md index 86ec2bf6..fa26e2a9 100644 --- a/docs/migrate_to_v2.md +++ b/docs/migrate_to_v2.md @@ -1,7 +1,21 @@ -## Migration from v1 and v2 +## Migration from v1 to v2 Below are the steps to migrate the go sdk from v1 to v2. +## Breaking Changes + +| Area | V1 | V2 | +|------|----|----| +| **Client initialization** | `common.Configuration{VaultURL, TokenProvider}` + `Skyflow.Init()` | `common.VaultConfig{VaultId, ClusterId, Credentials}` + `client.NewSkyflow(client.WithVaults(...))` | +| **Vault URL** | Single `VaultURL` string | Split into `VaultId` + `ClusterId` | +| **Request/response types** | Raw `map[string]interface{}` JSON objects | Typed structs — e.g. `common.InsertRequest` / `InsertResponse` | +| **Error structure** | `{code, description}` | `{httpStatus, grpcCode, httpCode, message, requestId, details}` | +| **Logging** | Global log level | Per-instance via `client.WithLogLevel(logger.INFO)` | +| **Import paths** | `github.com/skyflowapi/skyflow-go/skyflow/...` | `github.com/skyflowapi/skyflow-go/v2/...` | + +--- + + ### **Authentication options** In V2, we have introduced multiple authentication options. You can now provide credentials in the following ways: diff --git a/serviceaccount/go.mod b/serviceaccount/go.mod index d06537dd..d9a4a16f 100644 --- a/serviceaccount/go.mod +++ b/serviceaccount/go.mod @@ -1,3 +1,5 @@ +// Deprecated: skyflow-go v1.x is deprecated and will reach End of Life on October 31, 2026. Please migrate to v2: https://github.com/skyflowapi/skyflow-go/blob/main/docs/migrate_to_v2.md + module github.com/skyflowapi/skyflow-go/serviceaccount go 1.18 diff --git a/skyflow/common/common.go b/skyflow/common/common.go index 0d2ce1cb..e775d9d3 100644 --- a/skyflow/common/common.go +++ b/skyflow/common/common.go @@ -188,4 +188,4 @@ const ( ) const sdk_name = "skyflow-go" -const sdk_version = "1.10.0" +const sdk_version = "1.10.3" diff --git a/skyflow/go.mod b/skyflow/go.mod index 1d5a3aeb..c2f0712b 100644 --- a/skyflow/go.mod +++ b/skyflow/go.mod @@ -1,3 +1,5 @@ +// Deprecated: skyflow-go v1.x is deprecated and will reach End of Life on October 31, 2026. Please migrate to v2: https://github.com/skyflowapi/skyflow-go/blob/main/docs/migrate_to_v2.md + module github.com/skyflowapi/skyflow-go/skyflow go 1.18 From 7e6b31c356eff0dc67e7dda706d5bd3fcb416a5c Mon Sep 17 00:00:00 2001 From: Aadarsh Date: Wed, 27 May 2026 16:10:05 +0530 Subject: [PATCH 2/4] SK-2848: Updated commit hash --- serviceaccount/go.mod | 4 ++-- serviceaccount/go.sum | 17 ++++------------- skyflow/go.mod | 4 ++-- skyflow/go.sum | 16 ++++------------ 4 files changed, 12 insertions(+), 29 deletions(-) diff --git a/serviceaccount/go.mod b/serviceaccount/go.mod index d9a4a16f..e9dc19fb 100644 --- a/serviceaccount/go.mod +++ b/serviceaccount/go.mod @@ -7,8 +7,8 @@ go 1.18 require ( github.com/golang-jwt/jwt/v4 v4.5.2 github.com/joho/godotenv v1.4.0 - github.com/skyflowapi/skyflow-go/commonutils v0.0.0-20260106102501-e4411ad29dfd - github.com/skyflowapi/skyflow-go/skyflow v0.0.0-20260106102501-e4411ad29dfd + github.com/skyflowapi/skyflow-go/commonutils v0.0.0-20260527103333-ebb507496b70 + github.com/skyflowapi/skyflow-go/skyflow v0.0.0-20260527103333-ebb507496b70 ) require ( diff --git a/serviceaccount/go.sum b/serviceaccount/go.sum index ce8a8e37..d582d13e 100644 --- a/serviceaccount/go.sum +++ b/serviceaccount/go.sum @@ -1,30 +1,21 @@ -github.com/cristalhq/jwt/v3 v3.1.0/go.mod h1:XOnIXst8ozq/esy5N1XOlSyQqBd+84fxJ99FK+1jgL8= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/golang-jwt/jwt/v4 v4.5.2 h1:YtQM7lnr8iZ+j5q71MGKkNw9Mn7AjHM68uc9g5fXeUI= github.com/golang-jwt/jwt/v4 v4.5.2/go.mod h1:m21LjoU+eqJr34lmDMbreY2eSTRJ1cv77w39/MY0Ch0= -github.com/hetiansu5/urlquery v1.2.7/go.mod h1:wFpZdTHRdwt7mk0EM/DdZEWtEN4xf8HJoH/BLXm/PG0= github.com/joho/godotenv v1.4.0 h1:3l4+N6zfMWnkbPEXKng2o2/MR5mSwTrBih4ZEkkz1lg= github.com/joho/godotenv v1.4.0/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= -github.com/sirupsen/logrus v1.8.1/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0= github.com/sirupsen/logrus v1.8.3 h1:DBBfY8eMYazKEJHb3JKpSPfpgd2mBCoNFlQx6C5fftU= github.com/sirupsen/logrus v1.8.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ= -github.com/skyflowapi/skyflow-go/commonutils v0.0.0-20231031082702-92eed6eb74b5 h1:E7ydAFkSeRyBggnzK/fPXvhKqVbLn2sEPKgA0uOzQeg= -github.com/skyflowapi/skyflow-go/commonutils v0.0.0-20231031082702-92eed6eb74b5/go.mod h1:C9IH9lBmu32OoVAFtwEUw9aN3bXG8lSVNy8K1fw69UY= -github.com/skyflowapi/skyflow-go/commonutils v0.0.0-20260106102501-e4411ad29dfd h1:3MIejEaa7V2KeiQ3IzU7qrlp1vQDG9wFlTciijaT12Y= -github.com/skyflowapi/skyflow-go/commonutils v0.0.0-20260106102501-e4411ad29dfd/go.mod h1:M1Dmira+H7Tmefk7irvX21Je/XhoT9xtp+zKj2dfx3U= -github.com/skyflowapi/skyflow-go/skyflow v0.0.0-20250717121725-49a302340452 h1:kBJEUU6vqLz6698WLZxDDGCS6cue/P4mqQ8/gEMr7dI= -github.com/skyflowapi/skyflow-go/skyflow v0.0.0-20250717121725-49a302340452/go.mod h1:FNodd70EJXTesQbPEuUqnJygnghIH+oC2lsTRpGQU9A= -github.com/skyflowapi/skyflow-go/skyflow v0.0.0-20260106102501-e4411ad29dfd h1:VO6UqUB9IlD8K8dfQVhrVeh2fCUjfR+Lr2/K0Upt3wI= -github.com/skyflowapi/skyflow-go/skyflow v0.0.0-20260106102501-e4411ad29dfd/go.mod h1:1ERDPEGbFP5kUW6WVi/rcROjlPwBaCrwLE8uPGiUVwY= +github.com/skyflowapi/skyflow-go/commonutils v0.0.0-20260527103333-ebb507496b70 h1:dJ/eMppgZfhKBdvpEMNmOGssB+HqTzwOXnRSGKdWxHE= +github.com/skyflowapi/skyflow-go/commonutils v0.0.0-20260527103333-ebb507496b70/go.mod h1:3xeyQmRiKwnjbqHPAKLjPblIH04gEGEJ689nT32P4CA= +github.com/skyflowapi/skyflow-go/skyflow v0.0.0-20260527103333-ebb507496b70 h1:MriiF6jyDvaX/2P+YSbWhRxwQiEhoLIWnZ1yg45R3j4= +github.com/skyflowapi/skyflow-go/skyflow v0.0.0-20260527103333-ebb507496b70/go.mod h1:1QxMdHoqTC1G15pSZ93/SvOKArYq4bwHbFNNQMqde4E= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= -github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY= github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= -golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 h1:0A+M6Uqn+Eje4kHMK80dtF3JCXC4ykBgQG4Fe06QRhQ= golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= diff --git a/skyflow/go.mod b/skyflow/go.mod index c2f0712b..f61f41c6 100644 --- a/skyflow/go.mod +++ b/skyflow/go.mod @@ -8,8 +8,8 @@ require ( github.com/cristalhq/jwt/v3 v3.1.0 github.com/hetiansu5/urlquery v1.2.7 github.com/joho/godotenv v1.4.0 - github.com/skyflowapi/skyflow-go/commonutils v0.0.0-20260106102501-e4411ad29dfd - github.com/skyflowapi/skyflow-go/serviceaccount v0.0.0-20260106102501-e4411ad29dfd + github.com/skyflowapi/skyflow-go/commonutils v0.0.0-20260527103333-ebb507496b70 + github.com/skyflowapi/skyflow-go/serviceaccount v0.0.0-20260527103333-ebb507496b70 github.com/stretchr/testify v1.7.0 ) diff --git a/skyflow/go.sum b/skyflow/go.sum index 4b60ae12..d0a790e8 100644 --- a/skyflow/go.sum +++ b/skyflow/go.sum @@ -11,23 +11,15 @@ github.com/joho/godotenv v1.4.0 h1:3l4+N6zfMWnkbPEXKng2o2/MR5mSwTrBih4ZEkkz1lg= github.com/joho/godotenv v1.4.0/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= -github.com/sirupsen/logrus v1.8.1/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0= github.com/sirupsen/logrus v1.8.3 h1:DBBfY8eMYazKEJHb3JKpSPfpgd2mBCoNFlQx6C5fftU= github.com/sirupsen/logrus v1.8.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ= -github.com/skyflowapi/skyflow-go/commonutils v0.0.0-20231031082702-92eed6eb74b5 h1:E7ydAFkSeRyBggnzK/fPXvhKqVbLn2sEPKgA0uOzQeg= -github.com/skyflowapi/skyflow-go/commonutils v0.0.0-20231031082702-92eed6eb74b5/go.mod h1:C9IH9lBmu32OoVAFtwEUw9aN3bXG8lSVNy8K1fw69UY= -github.com/skyflowapi/skyflow-go/commonutils v0.0.0-20260106102501-e4411ad29dfd h1:3MIejEaa7V2KeiQ3IzU7qrlp1vQDG9wFlTciijaT12Y= -github.com/skyflowapi/skyflow-go/commonutils v0.0.0-20260106102501-e4411ad29dfd/go.mod h1:M1Dmira+H7Tmefk7irvX21Je/XhoT9xtp+zKj2dfx3U= -github.com/skyflowapi/skyflow-go/serviceaccount v0.0.0-20250717121939-a83549f30eaf h1:5ZBAwh3ZHpbIuLZUpTsSzTBicFVskQnBcps7pzaqLTA= -github.com/skyflowapi/skyflow-go/serviceaccount v0.0.0-20250717121939-a83549f30eaf/go.mod h1:CaDJCykQUsoIDHTzOYzg5gc+DaEBKf06PsKJ8BjdYrs= -github.com/skyflowapi/skyflow-go/serviceaccount v0.0.0-20260106102501-e4411ad29dfd h1:eze6cpEXM9SwMBlqIkPWJsAs0qU4V2jw/u2Hmz4rRqk= -github.com/skyflowapi/skyflow-go/serviceaccount v0.0.0-20260106102501-e4411ad29dfd/go.mod h1:x60VyDqa65bTUmzDa8bBZHuo0p+xM+sKkx/9YTj/3Xk= -github.com/skyflowapi/skyflow-go/skyflow v0.0.0-20250717121725-49a302340452/go.mod h1:FNodd70EJXTesQbPEuUqnJygnghIH+oC2lsTRpGQU9A= +github.com/skyflowapi/skyflow-go/commonutils v0.0.0-20260527103333-ebb507496b70 h1:dJ/eMppgZfhKBdvpEMNmOGssB+HqTzwOXnRSGKdWxHE= +github.com/skyflowapi/skyflow-go/commonutils v0.0.0-20260527103333-ebb507496b70/go.mod h1:3xeyQmRiKwnjbqHPAKLjPblIH04gEGEJ689nT32P4CA= +github.com/skyflowapi/skyflow-go/serviceaccount v0.0.0-20260527103333-ebb507496b70 h1:z+koIhxP/VgCRRi/GpAG4wHxskLA04Ju/DAXV/ZTDGg= +github.com/skyflowapi/skyflow-go/serviceaccount v0.0.0-20260527103333-ebb507496b70/go.mod h1:GkNIojWnJ+ryq6oPVaKnzBpgzd3hzyCxJI33mcXuAMw= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= -github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY= github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= -golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 h1:0A+M6Uqn+Eje4kHMK80dtF3JCXC4ykBgQG4Fe06QRhQ= golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= From 4f7bd0d349a36b3c21e73f8aab496e93fe9aff86 Mon Sep 17 00:00:00 2001 From: Aadarsh Date: Wed, 27 May 2026 16:22:59 +0530 Subject: [PATCH 3/4] SK-2848: Updated migration doc --- docs/migrate_to_v2.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/docs/migrate_to_v2.md b/docs/migrate_to_v2.md index fa26e2a9..16483130 100644 --- a/docs/migrate_to_v2.md +++ b/docs/migrate_to_v2.md @@ -4,14 +4,11 @@ Below are the steps to migrate the go sdk from v1 to v2. ## Breaking Changes -| Area | V1 | V2 | -|------|----|----| -| **Client initialization** | `common.Configuration{VaultURL, TokenProvider}` + `Skyflow.Init()` | `common.VaultConfig{VaultId, ClusterId, Credentials}` + `client.NewSkyflow(client.WithVaults(...))` | -| **Vault URL** | Single `VaultURL` string | Split into `VaultId` + `ClusterId` | -| **Request/response types** | Raw `map[string]interface{}` JSON objects | Typed structs — e.g. `common.InsertRequest` / `InsertResponse` | -| **Error structure** | `{code, description}` | `{httpStatus, grpcCode, httpCode, message, requestId, details}` | -| **Logging** | Global log level | Per-instance via `client.WithLogLevel(logger.INFO)` | -| **Import paths** | `github.com/skyflowapi/skyflow-go/skyflow/...` | `github.com/skyflowapi/skyflow-go/v2/...` | +- **Client initialization:** `TokenProvider`/`VaultURL` pattern replaced by `Credentials` + `VaultConfig` passed to `client.NewSkyflow()`. `VaultURL` is now split into `VaultId` + `ClusterId`. +- **Request/response types:** Operations like insert, get, and detokenize now use typed request/response structs (e.g., `common.InsertRequest` / `InsertResponse`) instead of raw `map[string]interface{}`. +- **Error handling:** Error objects restructured to include `httpStatusCode`, `details`, and `requestId` for richer debugging. +- **Logging:** Global log level replaced by per-instance log level set on the Skyflow client via `client.WithLogLevel(logger.INFO)`. +- **Import paths:** All imports updated from `github.com/skyflowapi/skyflow-go/skyflow/...` to `github.com/skyflowapi/skyflow-go/v2/...`. --- @@ -247,7 +244,7 @@ options := common.InsertOptions{ContinueOnError: false, ReturnTokens: true, Toke #### Error structure In V2, we have enriched the error details to provide better debugging capabilities. The error response now includes: -- **httpStatus**: The HTTP status code. +- **httpStatusCode**: The HTTP status code. - **grpcCode**: The gRPC code associated with the error. - **details & message**: A detailed description of the error. - **requestId**: A unique request identifier for easier debugging. @@ -257,13 +254,13 @@ The error response now includes: ```json { "code": "", - "description": "", + "message": "", } ``` #### V2 (New): Error structure ```js { - "httpStatus": "", + "httpStatusCode": "", "grpcCode": "", "httpCode": "", "message": "", From 50b84dd84f75664749d66384cb36498f3f1431f2 Mon Sep 17 00:00:00 2001 From: Aadarsh Date: Wed, 27 May 2026 16:24:03 +0530 Subject: [PATCH 4/4] Sk-2848: Updated doc --- docs/migrate_to_v2.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/migrate_to_v2.md b/docs/migrate_to_v2.md index 16483130..ce6d9d8d 100644 --- a/docs/migrate_to_v2.md +++ b/docs/migrate_to_v2.md @@ -3,16 +3,12 @@ Below are the steps to migrate the go sdk from v1 to v2. ## Breaking Changes - - **Client initialization:** `TokenProvider`/`VaultURL` pattern replaced by `Credentials` + `VaultConfig` passed to `client.NewSkyflow()`. `VaultURL` is now split into `VaultId` + `ClusterId`. - **Request/response types:** Operations like insert, get, and detokenize now use typed request/response structs (e.g., `common.InsertRequest` / `InsertResponse`) instead of raw `map[string]interface{}`. - **Error handling:** Error objects restructured to include `httpStatusCode`, `details`, and `requestId` for richer debugging. - **Logging:** Global log level replaced by per-instance log level set on the Skyflow client via `client.WithLogLevel(logger.INFO)`. - **Import paths:** All imports updated from `github.com/skyflowapi/skyflow-go/skyflow/...` to `github.com/skyflowapi/skyflow-go/v2/...`. ---- - - ### **Authentication options** In V2, we have introduced multiple authentication options. You can now provide credentials in the following ways: