Docs and migration for 1.0.0 #225

AsafMah · 2024-02-25T10:00:03Z

Added

Migration guides

Changed

doc files are re-written to be more standard

Bumps [golang.org/x/crypto](https://github.com/golang/crypto) from 0.14.0 to 0.17.0. - [Commits](golang/crypto@v0.14.0...v0.17.0) --- updated-dependencies: - dependency-name: golang.org/x/crypto dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Changed just sstream to false. the rest was fine * Switched rows

github-actions · 2024-02-25T10:03:20Z

Test Results

0 tests 0 ✅ 0s ⏱️
0 suites 0 💤
0 files 0 ❌

Results for commit b30baf5.

♻️ This comment has been updated with latest results.

codecov · 2024-02-25T10:03:44Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 54.19%. Comparing base (44f8e5a) to head (b30baf5).
Report is 79 commits behind head on the-big-split.

Additional details and impacted files

@@                Coverage Diff                @@
##           the-big-split     #225      +/-   ##
=================================================
+ Coverage          51.53%   54.19%   +2.65%     
=================================================
  Files                 53       70      +17     
  Lines               5877     5615     -262     
=================================================
+ Hits                3029     3043      +14     
+ Misses              2632     2345     -287     
- Partials             216      227      +11

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

ohadbitt · 2024-02-25T13:05:53Z

MIGRATION.md

+
+To migrate from the old SDK to the new one, you'll need to update your `go.mod` file's dependencies.
+
+**Old SDK:**


why needed ? can just put the new ..

So people can find the parts of the code they need to replace. @yogilad WDYT?

Very much, this being a migration guide.

MIGRATION.md

ohadbitt · 2024-02-25T13:08:30Z

MIGRATION.md

+
+### Using the New Packages
+
+Update your code to use the new packages.


Suggested change

Update your code to use the new packages.

Update your code with the new package API

I don't think this sentence is better, the point is the packages themselves are new

MIGRATION.md

ohadbitt · 2024-02-25T13:17:00Z

MIGRATION.md

+
+The new SDK returns a dataset object, with the ability to handle different tables as they come:
+```go
+dataset, err := client.QueryIterative(ctx, "database", query)


So we want iterative to be the default user behavior ?

I'd show a non-iterative and an iterative example in that order

MIGRATION.md

ohadbitt · 2024-02-25T13:18:11Z

MIGRATION.md

+
+You can also use the `Query` method to get all the results at once:
+```go
+dataset, err := client.Query(ctx, "database", query)


add here how to get the primary resultsl

ohadbitt · 2024-02-25T13:44:52Z

MIGRATION.md

+    // Handle error
+}
+
+defer ingestor.Close() // Always close the ingestor when done.


shouldnt we close if err != nil ?

If err != nil then the dataset is nil

ohadbitt · 2024-02-25T13:45:04Z

README.md

@@ -1,4 +1,4 @@
-# Microsoft Azure Data Explorer Public Preview (Kusto) [![GoDoc](https://godoc.org/github.com/Azure/azure-kusto-go?status.svg)](https://pkg.go.dev/github.com/Azure/azure-kusto-go/azkustodata) [![GoDoc](https://godoc.org/github.com/Azure/azure-kusto-go?status.svg)](https://pkg.go.dev/github.com/Azure/azure-kusto-go/azkustoingest)
+# Microsoft Azure Data Explorer (Kusto) [![GoDoc](https://godoc.org/github.com/Azure/azure-kusto-go?status.svg)](https://pkg.go.dev/github.com/Azure/azure-kusto-go/azkustodata) [![GoDoc](https://godoc.org/github.com/Azure/azure-kusto-go?status.svg)](https://pkg.go.dev/github.com/Azure/azure-kusto-go/azkustoingest)


MIGRATION.md

yogilad · 2024-02-26T10:13:41Z

MIGRATION.md

+
+Old SDK:
+```go
+kustoConnectionStringBuilder := kusto.NewConnectionStringBuilder(endpoint)


This is just a KCSB.
Do you want to show the client?

Also, is there value in showing these segmented line cases or do we want to focus on scenario examples (query, query with params, management command, ingest from , stream from, ... )

The idea is to demonstrate the new package name.

I wanted to give an overview of things they should change if they're migrating.
For more detailed examples they have the README and example files

yogilad · 2024-02-26T10:14:40Z

MIGRATION.md

+    query := kusto.NewStmt("systemNodes | project CollectionTime, NodeId")
+```
+
+For the new SDK, use the `azkustodata/kql` package to build queries, which has a type-safe query builder:


is there an example of query parameters somewhere?

Yes in the README.md

Should it also be in the migration?

only if there's a change to the class names or usage

yogilad · 2024-02-26T10:15:52Z

MIGRATION.md

+
+The new SDK returns a dataset object, with the ability to handle different tables as they come:
+```go
+dataset, err := client.QueryIterative(ctx, "database", query)


I'd show a non-iterative and an iterative example in that order

Co-authored-by: ohad bitton <[email protected]>

Co-authored-by: Yochai Gilad <[email protected]>

yogilad · 2024-03-03T19:51:46Z

MIGRATION.md

+
+To migrate from the old SDK to the new one, you'll need to update your `go.mod` file's dependencies.
+
+**Old SDK:**


Very much, this being a migration guide.

yogilad · 2024-03-03T19:52:41Z

MIGRATION.md

+
+The new SDK returns a dataset object, with the ability to handle different tables as they come:
+```go
+dataset, err := client.QueryIterative(ctx, "database", query)


# Conflicts: # .github/workflows/build.yml # CHANGELOG.md # azkustoingest/go.mod # azkustoingest/go.sum # quickstart/go.mod # quickstart/go.sum

* Split & rename modules * fix go.mod * rename to azkustodata and azkustoingest * update * Update build.yml * build.yml changes * fixes * build * fixed merge * try * restore dataset.csv * ### Added - azidentity package dependency ### Changed - Update azkustoingest/test/etoe/etoe_test.go to use azkustoingest.FileOption ### Fixed ### Removed ### Security * Fixed * Centralize deps * Fixed once_test.go * Fixed once_test.go * Fixed once_test.go * Minor fixes * Solved flakeyness maybe * remove replace * no replacements * Will this fail? * Will this fail? * Will this fail? * Will this fail? * Will this fail? * Will this fail? * Ok check 1 * Tidy * TidyDoc fixes * Split e2e tests * Updated deps * go work sync * this is not good * Test change * Test change * PR fixes * Fix more * Stop more queries * Stop more queries * Check if problem test * Rename package * Rename package * Rename package * Gofmt * Fixed error * tidy * Tidy part 2 * go.sum * Ingest updates for split (#198) * * [BREAKING] [MAJOR] Constructing ingest clients is now done using a KustoConnectionStringBuilder, and not a client struct. * In addition, passing a default database and table for ingestion is not necessary anymore, and can be done using Options. ```go // before: queryClient := kusto.New("https://ingest-somecluster.kusto.windows.net") client := ingest.New(quetryClient, "some-db", "some-table") // after: client := azkustoingest.New("https://ingest-somecluster.kusto.windows.net", azkustoingest.WithDefaultDatabase("someDb"), azkustoingest.WithDefaultTable("someTable")) ``` * Added autocorrection for endpoints for ingest clients. When creating a client, the "ingest-" will be added or removed as needed. To avoid this behavior, use the `azkustoingest.WithoutEndpointCorrection()` option. * ManagedStreamingClient constructor now only requires the query endpoint, and will infer the ingest endpoint from it. If you want to use a different endpoint, use the `azkustoingest.WithCustomIngestConnectionString()` option. * Removed the old deprecated Stream() method on queued ingest client, instead use azkustoingest.NewStreaming() or azkustoingest.NewManaged() for proper streaming ingest client. * Removed `QueryIngestion()` option for Query client. If you want to perform commands against the dm, create a query client with the "ingest-" endpoint. * Tests and docs * More tests * fmt * fmt * Try to improve build errors * f * f * Try again * Try again * Try again * Fix * Update README.md Co-authored-by: Yochai Gilad <[email protected]> * Update azkustoingest/common.go Co-authored-by: Yochai Gilad <[email protected]> * Rename * Remove queryclient * Remove queryclient * Remove queryclient * Remove queryclient --------- Co-authored-by: Yochai Gilad <[email protected]> * Merge branch 'master' into query-v2 * merge from main * Updated deps * Fixed * Merge fixes * Merge fixes * Query v2 (#216) * Frame definitions * Working json (kinda) * Improved values * Improved values * Improved values * Compilation errors * More fixes * meanwhile commit * merge from main * Reworked kusto types - No more duplications between packages. Removed old system of query building. Fixed tests, etc. * Query v2 - tables, frames, all * Added query * More tests * Working tests * More tests * Something is off * Something is off * Fixed error * More tests, more tables * Fixed tests, aligned types, etc * -int types can be deserialized to struct (with error on overflow) -fixed secondary tables * Easy row consumption and op for errors * Some docs * Examples and tests * Fixed tests * Fixed data races. Removed fixed table (for now) * Fixed deadlock + parallel tests * Fixed deadlocks * Fixed deadlocks * Rework tables into results * Big refactor - split common data from v2 specific * More v1 stuff * More v1 stuff * Moving stuff around for compile errors * Fixed tests * Fixed recursive lock issue * Fixed recursive lock issue * Fixed recursive lock issue * Fixed missing break * Fixed missing break * Fixed test * Make sure the correct error is always called, without race condition * Make sure the correct error is always called, without race condition * Make sure the correct error is always called, without race condition * upgrade * Merge fixes * Merge fixes * Tests and fixes * Tests and fixes * Split v2 tables to streaming and non-streaming * Fixed tests * Renames * Fixed error * Renaming * More api and partial results test * Fixed read * Some docs * -Renames and add apis -Fixed partial Results text -Fixed full errors tests * full dataset tests * Fixed tests * Handle partial errors in v2 & fixed number handling in v1 * Naming and comments * PR fixes * PR fixes * Added error description and table progress * Added error description and table progress * Fix tests * PR fixes * Fix tests * Removed more old code, fixed tests, still wip * Fixed all tests * Fixed + added benchmark * Fixed ingest tests by relocating mock * Fixed tests * More fixed tests * Fixed race * typo * remove todo (for now) * Cherrypick changes from other branch * -Simplify and rename * PR Changes: - Simplify code to handle only what needed - Rename ordinal to index - Some comments * Fixed samples * Fixed cycle * Removed old full dataset things * Renames and bug fixes * Aligned types, made full tables make more sense. * Properly close tables, fixed deadlocks and tests. * Fixed ingest tests * Fixed test * build.yml * Updated sample app * Improve allocations and fix benchmarks * Improve values system * -Reduced code dups in structs -Fixed edge cases * Jsontest - correct order of params * cache decodeToStruct result * PR stuff * PR stuff * PR changes - part 1 * PR Changes - renames * Readne * Lock Cache * Docs and migration for 1.0.0 (#225) * Bump golang.org/x/crypto from 0.14.0 to 0.17.0 (#219) Bumps [golang.org/x/crypto](https://github.com/golang/crypto) from 0.14.0 to 0.17.0. - [Commits](golang/crypto@v0.14.0...v0.17.0) --- updated-dependencies: - dependency-name: golang.org/x/crypto dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump golang.org/x/crypto from 0.14.0 to 0.17.0 in /quickstart (#218) Bumps [golang.org/x/crypto](https://github.com/golang/crypto) from 0.14.0 to 0.17.0. - [Commits](golang/crypto@v0.14.0...v0.17.0) --- updated-dependencies: - dependency-name: golang.org/x/crypto dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Changed just sstream to false. the rest was fine (#220) * Update issue templates (#223) * Update build.yml * Update build.yml (#224) * T ronmoneta/compression auto detect fix (#222) * Changed just sstream to false. the rest was fine * Switched rows * New doc files and Migration guide * Update MIGRATION.md Co-authored-by: ohad bitton <[email protected]> * Update MIGRATION.md Co-authored-by: ohad bitton <[email protected]> * Update MIGRATION.md Co-authored-by: Yochai Gilad <[email protected]> * New doc files and Migration guide * Last fixes * azkustodata tidy * version fixing * version fixing --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: t-ronmoneta <[email protected]> Co-authored-by: ohad bitton <[email protected]> Co-authored-by: Yochai Gilad <[email protected]> * v1.0.0-preview * last adjustments * last adjustments * last adjustments * last adjustments * last adjustments --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Yochai Gilad <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: t-ronmoneta <[email protected]> Co-authored-by: ohad bitton <[email protected]>

dependabot bot and others added 8 commits December 19, 2023 12:07

Changed just sstream to false. the rest was fine (#220)

f980be0

Update issue templates (#223)

74af1ca

Update build.yml

26d911c

Update build.yml (#224)

5203460

T ronmoneta/compression auto detect fix (#222)

b584ce2

* Changed just sstream to false. the rest was fine * Switched rows

New doc files and Migration guide

7dff3f9

AsafMah requested a review from yogilad February 25, 2024 10:00

ohadbitt reviewed Feb 25, 2024

View reviewed changes

yogilad reviewed Feb 26, 2024

View reviewed changes

AsafMah and others added 4 commits February 26, 2024 15:50

Update MIGRATION.md

88ab066

Co-authored-by: ohad bitton <[email protected]>

Update MIGRATION.md

c309bda

Co-authored-by: ohad bitton <[email protected]>

Update MIGRATION.md

2b8ac33

Co-authored-by: Yochai Gilad <[email protected]>

New doc files and Migration guide

663b749

yogilad approved these changes Mar 3, 2024

View reviewed changes

AsafMah added 5 commits March 4, 2024 15:23

Merge branch 'master' into docs-and-migration

4c5250f

# Conflicts: # .github/workflows/build.yml # CHANGELOG.md # azkustoingest/go.mod # azkustoingest/go.sum # quickstart/go.mod # quickstart/go.sum

Last fixes

643fd84

azkustodata tidy

dfe0074

version fixing

e1cb185

version fixing

b30baf5

AsafMah merged commit f037b7d into the-big-split Mar 6, 2024
8 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs and migration for 1.0.0 #225

Docs and migration for 1.0.0 #225

AsafMah commented Feb 25, 2024

github-actions bot commented Feb 25, 2024 •

edited

Loading

codecov bot commented Feb 25, 2024 •

edited

Loading

ohadbitt Feb 25, 2024

AsafMah Feb 26, 2024

yogilad Mar 3, 2024

ohadbitt Feb 25, 2024

AsafMah Feb 26, 2024

ohadbitt Feb 25, 2024

yogilad Feb 26, 2024

AsafMah Feb 26, 2024

yogilad Mar 3, 2024

ohadbitt Feb 25, 2024

AsafMah Feb 26, 2024

ohadbitt Feb 25, 2024

AsafMah Feb 26, 2024

ohadbitt Feb 25, 2024

AsafMah Feb 26, 2024

yogilad Feb 26, 2024

yogilad Feb 26, 2024

AsafMah Feb 26, 2024

yogilad Feb 26, 2024

AsafMah Feb 26, 2024

yogilad Mar 3, 2024

yogilad Feb 26, 2024

yogilad Mar 3, 2024

yogilad Mar 3, 2024


		To migrate from the old SDK to the new one, you'll need to update your `go.mod` file's dependencies.

		Old SDK:


		### Using the New Packages

		Update your code to use the new packages.

	Update your code to use the new packages.
	Update your code with the new package API

		@@ -1,4 +1,4 @@
		# Microsoft Azure Data Explorer Public Preview (Kusto) [![GoDoc](https://godoc.org/github.com/Azure/azure-kusto-go?status.svg)](https://pkg.go.dev/github.com/Azure/azure-kusto-go/azkustodata) [![GoDoc](https://godoc.org/github.com/Azure/azure-kusto-go?status.svg)](https://pkg.go.dev/github.com/Azure/azure-kusto-go/azkustoingest)
		# Microsoft Azure Data Explorer (Kusto) [![GoDoc](https://godoc.org/github.com/Azure/azure-kusto-go?status.svg)](https://pkg.go.dev/github.com/Azure/azure-kusto-go/azkustodata) [![GoDoc](https://godoc.org/github.com/Azure/azure-kusto-go?status.svg)](https://pkg.go.dev/github.com/Azure/azure-kusto-go/azkustoingest)

Docs and migration for 1.0.0 #225

Docs and migration for 1.0.0 #225

Conversation

AsafMah commented Feb 25, 2024

Added

Changed

github-actions bot commented Feb 25, 2024 • edited Loading

Test Results

codecov bot commented Feb 25, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Feb 25, 2024 •

edited

Loading

codecov bot commented Feb 25, 2024 •

edited

Loading