Merge branch 'main' into ex_basic-example_p2

Author: gridnevvvit

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.9.0 ##
+
+* fixed minor issue in SDK imports for Python 2.
+
 ## 2.7.0 ##
 
 * fixes in TxContext in ydb.aio module.

examples/basic_example_v1/README.md

@@ -0,0 +1,58 @@
+Running this sample with the managed YDB instance in Yandex Cloud
+---
+
+(0) Install the required Python dependencies
+
+python3 -m pip install iso8601
+python3 -m pip install 'ydb[yc]'
+
+(1) Install the yc command line tool
+
+https://cloud.yandex.ru/docs/cli/operations/install-cli
+
+(2) Create the service account using the YC Web Console, and assign it the ydb.editor role.
+
+Alternatively use the following shell snippet:
+
+```bash
+# Specify the Yandex Cloud folder and service account name
+export YC_FOLDER=mzinal
+export SA_NAME=ydb-sa-0
+# Create the service account
+yc iam service-account create $SA_NAME
+# Obtain the service account id
+export SA_ID=`yc iam service-account get --name $SA_NAME | sed -n 's/^id: \(.*\)$/\1/p'`
+# Assign the ydb.editor role for the specified YC folder to the service account just created
+yc resource-manager folder add-access-binding $YC_FOLDER --role ydb.editor --subject serviceAccount:$SA_ID 
+```
+
+(3) Generate the service account key to be used for authentication.
+
+Note: unfortunately, right now YC Web Console does not offer a way to generate the SA key
+with its Web interface.
+
+```bash
+yc iam key create --service-account-name $SA_NAME --output $HOME/key-ydb-sa-0.json
+```
+
+(4) Obtain the endpoint and database path from the Web Console.
+
+Alternatively, use the following command to grab the required data in the shell:
+
+```bash
+yc ydb db get --name ydb1
+```
+
+`ydb1` value in the command above is the logical name of the YDB managed database.
+
+(5) Run the sample:
+
+```bash
+# Set the path to the service account key file
+export YDB_SERVICE_ACCOUNT_KEY_FILE_CREDENTIALS=$HOME/key-ydb-sa-0.json
+# Set the database path and its endpoint
+export YDB_ENDPOINT=grpcs://ydb.serverless.yandexcloud.net:2135
+export YDB_DATABASE=/ru-central1/b1gfvslmokutuvt2g019/etnvbffeqegu1ub2rg2o
+# Run the script
+python3 __main__.py -e $YDB_ENDPOINT -d $YDB_DATABASE
+```

examples/basic_example_v1/basic_example.py

@@ -1,6 +1,5 @@
 # -*- coding: utf-8 -*-
-import os
-
+import posixpath
 import ydb
 import basic_example_data
 
@@ -269,7 +268,7 @@ def callee(session):
 
 def describe_table(pool, path, name):
     def callee(session):
-        result = session.describe_table(os.path.join(path, name))
+        result = session.describe_table(posixpath.join(path, name))
         print("\n> describe table: series")
         for column in result.columns:
             print("column, name:", column.name, ",", str(column.type.item).strip())
@@ -288,7 +287,7 @@ def bulk_upsert(table_client, path):
         .add_column("air_date", ydb.OptionalType(ydb.PrimitiveType.Uint64))
     )
     rows = basic_example_data.get_episodes_data_for_bulk_upsert()
-    table_client.bulk_upsert(os.path.join(path, "episodes"), rows, column_types)
+    table_client.bulk_upsert(posixpath.join(path, "episodes"), rows, column_types)
 
 
 def is_directory_exists(driver, path):
@@ -302,11 +301,11 @@ def ensure_path_exists(driver, database, path):
     paths_to_create = list()
     path = path.rstrip("/")
     while path not in ("", database):
-        full_path = os.path.join(database, path)
+        full_path = posixpath.join(database, path)
         if is_directory_exists(driver, full_path):
             break
         paths_to_create.append(full_path)
-        path = os.path.dirname(path).rstrip("/")
+        path = posixpath.dirname(path).rstrip("/")
 
     while len(paths_to_create) > 0:
         full_path = paths_to_create.pop(-1)
@@ -323,7 +322,7 @@ def run(endpoint, database, path):
 
             # absolute path - prefix to the table's names,
             # including the database location
-            full_path = os.path.join(database, path)
+            full_path = posixpath.join(database, path)
 
             create_tables(pool, full_path)
 

examples/service-account-credentials/main.py

@@ -26,8 +26,10 @@ def main():
         # specify YDB_DATABASE environment variable.
         database=os.getenv("YDB_DATABASE"),
         # construct the service account credentials instance
+        #   service account key should be in the local file,
+        #   and SA_KEY_FILE environment variable should point to it
         credentials=ydb.iam.ServiceAccountCredentials.from_file(
-            "~/.ydb/sa.json",
+            os.getenv("SA_KEY_FILE"),
         ),
     )
 

setup.py

@@ -6,7 +6,7 @@
 
 setuptools.setup(
     name="ydb",
-    version="2.8.0",
+    version="2.9.0",
     description="YDB Python SDK",
     author="Yandex LLC",
     author_email="[email protected]",

ydb/__init__.py

@@ -17,5 +17,5 @@
 
 try:
     import ydb.aio as aio  # noqa
-except ImportError:
+except Exception:
     pass

ydb/ydb_version.py

@@ -1 +1 @@
-VERSION = "2.8.0"
+VERSION = "2.9.0"