Merge pull request #1085 from ydb-platform/slo

SLO native splitted to native/table and native/query

Author: asmyasnikov

.github/workflows/examples.yml

@@ -15,8 +15,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ydb-version: [ 22.5, 23.1, 23.2 ]
-        application: [ native, database_sql, gorm, xorm ]
+        ydb-version: [ 22.5, 23.1, 23.2, 23.3, 24.1 ]
+        application: [ native/table, native/query, database_sql, gorm, xorm ]
     services:
       ydb:
         image: cr.yandex/crpsjg1coh47p81vh2lc/yandex-docker-local-ydb:${{ matrix.ydb-version }}

.github/workflows/slo.yml

@@ -43,29 +43,35 @@ jobs:
           timeBetweenPhases: 30
           shutdownTime: 30
 
-          language_id0: 'native'
+          language_id0: 'native/table'
           workload_path0: 'tests/slo'
-          language0: 'Go SDK native'
+          language0: 'Go SDK native over table-service'
           workload_build_context0: ../..
-          workload_build_options0: -f Dockerfile --build-arg SRC_PATH=native --build-arg JOB_NAME=workload-native
+          workload_build_options0: -f Dockerfile --build-arg SRC_PATH=native/table --build-arg JOB_NAME=workload-native-table
 
-          language_id1: 'databasesql'
+          language_id1: 'query'
           workload_path1: 'tests/slo'
-          language1: 'Go SDK database/sql'
+          language1: 'Go SDK native over query-service'
           workload_build_context1: ../..
-          workload_build_options1: -f Dockerfile --build-arg SRC_PATH=database/sql --build-arg JOB_NAME=workload-databasesql
+          workload_build_options1: -f Dockerfile --build-arg SRC_PATH=native/query --build-arg JOB_NAME=workload-native-query
 
-          language_id2: 'gorm'
+          language_id2: 'database/sql'
           workload_path2: 'tests/slo'
-          language2: 'Go SDK gorm'
+          language2: 'Go SDK database/sql'
           workload_build_context2: ../..
-          workload_build_options2: -f Dockerfile --build-arg SRC_PATH=gorm --build-arg JOB_NAME=workload-gorm
+          workload_build_options2: -f Dockerfile --build-arg SRC_PATH=database/sql --build-arg JOB_NAME=workload-database-sql
 
-          language_id3: 'xorm'
+          language_id3: 'gorm'
           workload_path3: 'tests/slo'
-          language3: 'Go SDK xorm'
+          language3: 'Go SDK gorm'
           workload_build_context3: ../..
-          workload_build_options3: -f Dockerfile --build-arg SRC_PATH=xorm --build-arg JOB_NAME=workload-xorm
+          workload_build_options3: -f Dockerfile --build-arg SRC_PATH=gorm --build-arg JOB_NAME=workload-gorm
+
+          language_id4: 'xorm'
+          workload_path4: 'tests/slo'
+          language4: 'Go SDK xorm'
+          workload_build_context4: ../..
+          workload_build_options4: -f Dockerfile --build-arg SRC_PATH=xorm --build-arg JOB_NAME=workload-xorm
 
       - uses: actions/upload-artifact@v3
         if: always()

examples/basic/native/README.md renamed to examples/basic/native/query/README.md

@@ -0,0 +1,8 @@
+# Basic example via native driver
+
+Basic example demonstrates the possibilities of `YDB`:
+ - create/drop/describe tables
+ - upsert data
+ - select with data query (request-response API)
+ - select with scan query (streaming API)
+ - read table (streaming API)

examples/basic/native/data.go renamed to examples/basic/native/query/data.go

@@ -0,0 +1,161 @@
+package main
+
+import (
+	"time"
+
+	"github.com/ydb-platform/ydb-go-sdk/v3/table/types"
+)
+
+func seriesData(id uint64, released time.Time, title, info, comment string) types.Value {
+	var commentv types.Value
+	if comment == "" {
+		commentv = types.NullValue(types.TypeUTF8)
+	} else {
+		commentv = types.OptionalValue(types.TextValue(comment))
+	}
+
+	return types.StructValue(
+		types.StructFieldValue("series_id", types.Uint64Value(id)),
+		types.StructFieldValue("release_date", types.DateValueFromTime(released)),
+		types.StructFieldValue("title", types.TextValue(title)),
+		types.StructFieldValue("series_info", types.TextValue(info)),
+		types.StructFieldValue("comment", commentv),
+	)
+}
+
+func seasonData(seriesID, seasonID uint64, title string, first, last time.Time) types.Value {
+	return types.StructValue(
+		types.StructFieldValue("series_id", types.Uint64Value(seriesID)),
+		types.StructFieldValue("season_id", types.Uint64Value(seasonID)),
+		types.StructFieldValue("title", types.TextValue(title)),
+		types.StructFieldValue("first_aired", types.DateValueFromTime(first)),
+		types.StructFieldValue("last_aired", types.DateValueFromTime(last)),
+	)
+}
+
+func episodeData(seriesID, seasonID, episodeID uint64, title string, date time.Time) types.Value {
+	return types.StructValue(
+		types.StructFieldValue("series_id", types.Uint64Value(seriesID)),
+		types.StructFieldValue("season_id", types.Uint64Value(seasonID)),
+		types.StructFieldValue("episode_id", types.Uint64Value(episodeID)),
+		types.StructFieldValue("title", types.TextValue(title)),
+		types.StructFieldValue("air_date", types.DateValueFromTime(date)),
+	)
+}
+
+func getSeriesData() types.Value {
+	return types.ListValue(
+		seriesData(
+			1, days("2006-02-03"), "IT Crowd", ""+
+				"The IT Crowd is a British sitcom produced by Channel 4, written by Graham Linehan, produced by "+
+				"Ash Atalla and starring Chris O'Dowd, Richard Ayoade, Katherine Parkinson, and Matt Berry.",
+			"", // NULL comment.
+		),
+		seriesData(
+			2, days("2014-04-06"), "Silicon Valley", ""+
+				"Silicon Valley is an American comedy television series created by Mike Judge, John Altschuler and "+
+				"Dave Krinsky. The series focuses on five young men who founded a startup company in Silicon Valley.",
+			"Some comment here",
+		),
+	)
+}
+
+func getSeasonsData() types.Value {
+	return types.ListValue(
+		seasonData(1, 1, "Season 1", days("2006-02-03"), days("2006-03-03")),
+		seasonData(1, 2, "Season 2", days("2007-08-24"), days("2007-09-28")),
+		seasonData(1, 3, "Season 3", days("2008-11-21"), days("2008-12-26")),
+		seasonData(1, 4, "Season 4", days("2010-06-25"), days("2010-07-30")),
+		seasonData(2, 1, "Season 1", days("2014-04-06"), days("2014-06-01")),
+		seasonData(2, 2, "Season 2", days("2015-04-12"), days("2015-06-14")),
+		seasonData(2, 3, "Season 3", days("2016-04-24"), days("2016-06-26")),
+		seasonData(2, 4, "Season 4", days("2017-04-23"), days("2017-06-25")),
+		seasonData(2, 5, "Season 5", days("2018-03-25"), days("2018-05-13")),
+	)
+}
+
+func getEpisodesData() types.Value {
+	return types.ListValue(
+		episodeData(1, 1, 1, "Yesterday's Jam", days("2006-02-03")),
+		episodeData(1, 1, 2, "Calamity Jen", days("2006-02-03")),
+		episodeData(1, 1, 3, "Fifty-Fifty", days("2006-02-10")),
+		episodeData(1, 1, 4, "The Red Door", days("2006-02-17")),
+		episodeData(1, 1, 5, "The Haunting of Bill Crouse", days("2006-02-24")),
+		episodeData(1, 1, 6, "Aunt Irma Visits", days("2006-03-03")),
+		episodeData(1, 2, 1, "The Work Outing", days("2006-08-24")),
+		episodeData(1, 2, 2, "Return of the Golden Child", days("2007-08-31")),
+		episodeData(1, 2, 3, "Moss and the German", days("2007-09-07")),
+		episodeData(1, 2, 4, "The Dinner Party", days("2007-09-14")),
+		episodeData(1, 2, 5, "Smoke and Mirrors", days("2007-09-21")),
+		episodeData(1, 2, 6, "Men Without Women", days("2007-09-28")),
+		episodeData(1, 3, 1, "From Hell", days("2008-11-21")),
+		episodeData(1, 3, 2, "Are We Not Men?", days("2008-11-28")),
+		episodeData(1, 3, 3, "Tramps Like Us", days("2008-12-05")),
+		episodeData(1, 3, 4, "The Speech", days("2008-12-12")),
+		episodeData(1, 3, 5, "Friendface", days("2008-12-19")),
+		episodeData(1, 3, 6, "Calendar Geeks", days("2008-12-26")),
+		episodeData(1, 4, 1, "Jen The Fredo", days("2010-06-25")),
+		episodeData(1, 4, 2, "The Final Countdown", days("2010-07-02")),
+		episodeData(1, 4, 3, "Something Happened", days("2010-07-09")),
+		episodeData(1, 4, 4, "Italian For Beginners", days("2010-07-16")),
+		episodeData(1, 4, 5, "Bad Boys", days("2010-07-23")),
+		episodeData(1, 4, 6, "Reynholm vs Reynholm", days("2010-07-30")),
+		episodeData(2, 1, 1, "Minimum Viable Product", days("2014-04-06")),
+		episodeData(2, 1, 2, "The Cap Table", days("2014-04-13")),
+		episodeData(2, 1, 3, "Articles of Incorporation", days("2014-04-20")),
+		episodeData(2, 1, 4, "Fiduciary Duties", days("2014-04-27")),
+		episodeData(2, 1, 5, "Signaling Risk", days("2014-05-04")),
+		episodeData(2, 1, 6, "Third Party Insourcing", days("2014-05-11")),
+		episodeData(2, 1, 7, "Proof of Concept", days("2014-05-18")),
+		episodeData(2, 1, 8, "Optimal Tip-to-Tip Efficiency", days("2014-06-01")),
+		episodeData(2, 2, 1, "Sand Hill Shuffle", days("2015-04-12")),
+		episodeData(2, 2, 2, "Runaway Devaluation", days("2015-04-19")),
+		episodeData(2, 2, 3, "Bad Money", days("2015-04-26")),
+		episodeData(2, 2, 4, "The Lady", days("2015-05-03")),
+		episodeData(2, 2, 5, "Server Space", days("2015-05-10")),
+		episodeData(2, 2, 6, "Homicide", days("2015-05-17")),
+		episodeData(2, 2, 7, "Adult Content", days("2015-05-24")),
+		episodeData(2, 2, 8, "White Hat/Black Hat", days("2015-05-31")),
+		episodeData(2, 2, 9, "Binding Arbitration", days("2015-06-07")),
+		episodeData(2, 2, 10, "Two Days of the Condor", days("2015-06-14")),
+		episodeData(2, 3, 1, "Founder Friendly", days("2016-04-24")),
+		episodeData(2, 3, 2, "Two in the Box", days("2016-05-01")),
+		episodeData(2, 3, 3, "Meinertzhagen's Haversack", days("2016-05-08")),
+		episodeData(2, 3, 4, "Maleant Data Systems Solutions", days("2016-05-15")),
+		episodeData(2, 3, 5, "The Empty Chair", days("2016-05-22")),
+		episodeData(2, 3, 6, "Bachmanity Insanity", days("2016-05-29")),
+		episodeData(2, 3, 7, "To Build a Better Beta", days("2016-06-05")),
+		episodeData(2, 3, 8, "Bachman's Earnings Over-Ride", days("2016-06-12")),
+		episodeData(2, 3, 9, "Daily Active Users", days("2016-06-19")),
+		episodeData(2, 3, 10, "The Uptick", days("2016-06-26")),
+		episodeData(2, 4, 1, "Success Failure", days("2017-04-23")),
+		episodeData(2, 4, 2, "Terms of Service", days("2017-04-30")),
+		episodeData(2, 4, 3, "Intellectual Property", days("2017-05-07")),
+		episodeData(2, 4, 4, "Teambuilding Exercise", days("2017-05-14")),
+		episodeData(2, 4, 5, "The Blood Boy", days("2017-05-21")),
+		episodeData(2, 4, 6, "Customer Service", days("2017-05-28")),
+		episodeData(2, 4, 7, "The Patent Troll", days("2017-06-04")),
+		episodeData(2, 4, 8, "The Keenan Vortex", days("2017-06-11")),
+		episodeData(2, 4, 9, "Hooli-Con", days("2017-06-18")),
+		episodeData(2, 4, 10, "Server Error", days("2017-06-25")),
+		episodeData(2, 5, 1, "Grow Fast or Die Slow", days("2018-03-25")),
+		episodeData(2, 5, 2, "Reorientation", days("2018-04-01")),
+		episodeData(2, 5, 3, "Chief Operating Officer", days("2018-04-08")),
+		episodeData(2, 5, 4, "Tech Evangelist", days("2018-04-15")),
+		episodeData(2, 5, 5, "Facial Recognition", days("2018-04-22")),
+		episodeData(2, 5, 6, "Artificial Emotional Intelligence", days("2018-04-29")),
+		episodeData(2, 5, 7, "Initial Coin Offering", days("2018-05-06")),
+		episodeData(2, 5, 8, "Fifty-One Percent", days("2018-05-13")),
+	)
+}
+
+const dateISO8601 = "2006-01-02"
+
+func days(date string) time.Time {
+	t, err := time.Parse(dateISO8601, date)
+	if err != nil {
+		panic(err)
+	}
+
+	return t
+}

examples/basic/native/main.go renamed to examples/basic/native/query/main.go

@@ -0,0 +1,74 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"os"
+	"path"
+	"time"
+
+	environ "github.com/ydb-platform/ydb-go-sdk-auth-environ"
+	"github.com/ydb-platform/ydb-go-sdk/v3"
+	"github.com/ydb-platform/ydb-go-sdk/v3/sugar"
+)
+
+func main() {
+	ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
+	defer cancel()
+
+	dsn, exists := os.LookupEnv("YDB_CONNECTION_STRING")
+	if !exists {
+		panic("YDB_CONNECTION_STRING environment variable not defined")
+	}
+
+	db, err := ydb.Open(ctx,
+		dsn,
+		environ.WithEnvironCredentials(ctx),
+	)
+	if err != nil {
+		panic(fmt.Errorf("connect error: %w", err))
+	}
+	defer func() { _ = db.Close(ctx) }()
+
+	prefix := path.Join(db.Name(), "native")
+
+	err = sugar.RemoveRecursive(ctx, db, prefix)
+	if err != nil {
+		panic(err)
+	}
+
+	err = describeTableOptions(ctx, db.Table())
+	if err != nil {
+		panic(fmt.Errorf("describe table options error: %w", err))
+	}
+
+	err = createTables(ctx, db.Table(), prefix)
+	if err != nil {
+		panic(fmt.Errorf("create tables error: %w", err))
+	}
+
+	err = describeTable(ctx, db.Table(), path.Join(prefix, "series"))
+	if err != nil {
+		panic(fmt.Errorf("describe table error: %w", err))
+	}
+
+	err = fillTablesWithData(ctx, db.Table(), prefix)
+	if err != nil {
+		panic(fmt.Errorf("fill tables with data error: %w", err))
+	}
+
+	err = selectSimple(ctx, db.Table(), prefix)
+	if err != nil {
+		panic(fmt.Errorf("select simple error: %w", err))
+	}
+
+	err = scanQuerySelect(ctx, db.Table(), prefix)
+	if err != nil {
+		panic(fmt.Errorf("scan query select error: %w", err))
+	}
+
+	err = readTable(ctx, db.Table(), path.Join(prefix, "series"))
+	if err != nil {
+		panic(fmt.Errorf("read table error: %w", err))
+	}
+}