switch main to v3

.github/scripts/increment_version_test.py

@@ -7,16 +7,17 @@
     [
         ("0.0.0", 'patch', False, "0.0.1"),
         ("0.0.1", 'patch', False, "0.0.2"),
-        ("0.0.1a1", 'patch', False, "0.0.1"),
-        ("0.0.0", 'patch', True, "0.0.1a1"),
-        ("0.0.1", 'patch', True, "0.0.2a1"),
-        ("0.0.2a1", 'patch', True, "0.0.2a2"),
+        ("0.0.1b1", 'patch', False, "0.0.1"),
+        ("0.0.0", 'patch', True, "0.0.1b1"),
+        ("0.0.1", 'patch', True, "0.0.2b1"),
+        ("0.0.2b1", 'patch', True, "0.0.2b2"),
         ("0.0.1", 'minor', False, "0.1.0"),
-        ("0.0.1a1", 'minor', False, "0.1.0"),
-        ("0.1.0a1", 'minor', False, "0.1.0"),
-        ("0.1.0", 'minor', True, "0.2.0a1"),
-        ("0.1.0a1", 'minor', True, "0.1.0a2"),
-        ("0.1.1a1", 'minor', True, "0.2.0a1"),
+        ("0.0.1b1", 'minor', False, "0.1.0"),
+        ("0.1.0b1", 'minor', False, "0.1.0"),
+        ("0.1.0", 'minor', True, "0.2.0b1"),
+        ("0.1.0b1", 'minor', True, "0.1.0b2"),
+        ("0.1.1b1", 'minor', True, "0.2.0b1"),
+        ("3.0.0b1", 'patch', True, "3.0.0b2"),
     ]
 )
 def test_increment_version(source, inc_type, with_beta, result):

.github/workflows/tests.yaml

@@ -11,24 +11,33 @@ jobs:
     runs-on: ubuntu-latest
 
     concurrency:
-      group: unit-${{ github.ref }}-${{ matrix.environment }}-${{ matrix.python-version }}
+      group: unit-${{ github.ref }}-${{ matrix.environment }}-${{ matrix.python-version }}-${{ matrix.folder }}
       cancel-in-progress: true
 
     strategy:
+      fail-fast: false
       max-parallel: 4
       matrix:
         python-version: [3.8]
         environment: [py, py-tls, py-proto3, py-tls-proto3]
+        folder: [ydb, tests]
+        exclude:
+          - environment: py-tls
+            folder: ydb
+          - environment: py-tls-proto3
+            folder: ydb
 
     steps:
     - uses: actions/checkout@v1
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
+
+    - name: Install tox
       run: |
         python -m pip install --upgrade pip
         pip install tox==4.2.6
-    - name: Test with tox
-      run: tox -e ${{ matrix.environment }}
+
+    - name: Run unit tests
+      run: tox -e ${{ matrix.environment }} -- ${{ matrix.folder }}

AUTHORS

@@ -1,4 +1,5 @@
-The following authors have created the source code of "YDB Python SDK"
+The following authors have created the source code of "Yandex Database Python SDK"
 published and distributed by YANDEX LLC as the owner:
 
 Vitalii Gridnev <gridnevvvit@gmail.com>
+Timofey Koolin <timofey.koolin@gmail.com>

CHANGELOG.md

@@ -1,3 +1,54 @@
+## 3.0.1b11 ##
+* Fixed global_allow_split_transactions
+* Added reader.receive_message() method
+* Swap topic_path and consumer arguments in topic_client.reader method
+
+## 3.0.1b10 ##
+* fixed sqlalchemy get_columns method with not null columns
+* fixed requirements.txt
+
+## 3.0.1b9 ##
+* Add function for global revert broken behaviour: ydb.global_allow_truncated_result, ydb.global_allow_split_transactions
+* Change argument names from deny_split_transactions to allow_split_transactions (with reverse value
+* Fixed check retriable for idempotent error
+* Reader codecs
+* Read one message
+* fixed sqlalchemy get_columns method with not null columns
+
+## 3.0.1b8 ##
+* Fixed exception while create ResultSet with None table_settings
+
+## 3.0.1b7 ##
+* BROKEN CHANGE: deny any action in transaction after commit/rollback
+* BROKEN CHANGE: raise exception for truncated response by default
+* Compatible protobaf detection for arcadia
+* Add codecs support for topic writer
+
+## 3.0.1b6 ##
+* BROKEN CHANGES: remove writer.write(mess1, mess2) variant, use list instead: writer.write([mess1, mess2])
+* BROKEN CHANGES: change names of public method in topic client
+* BROKEN CHANGES: rename parameter producer_and_message_group_id to producer_id
+* producer_id is optional now
+
+## 3.0.1b5 ##
+* Remove six package from code and dependencies (remove support python2)
+* Use anonymous credentials by default instead of iam metadata (use ydb.driver.credentials_from_env_variables for creds by env var)
+* Close grpc streams while closing readers/writers
+* Add control plane operations for topic api: create, drop
+* Add six package to requirements
+
+## 3.0.1b4 ##
+* Initial implementation of topic reader
+
+## 3.0.1b3 ##
+* Fix error of check retriable error for idempotent operations (error exist since 2.12.1)
+
+## 3.0.1b2 ##
+* Add initial topic writer
+
+## 3.0.1b1 ##
+* start 3.0 beta branch
+
 ## 2.13.4 ##
 * fixed sqlalchemy get_columns method with not null columns
 

docker-compose-tls.yml

@@ -1,7 +1,7 @@
 version: "3.9"
 services:
   ydb:
-    image: cr.yandex/yc/yandex-docker-local-ydb:latest
+    image: cr.yandex/yc/yandex-docker-local-ydb@sha256:b569c23d6854564ec4d970bda86cddcf5b11c7c6362df62beb8ba8eafb8d54fd
     restart: always
     ports:
       - 2136:2136

docker-compose.yml

@@ -1,7 +1,7 @@
 version: "3.9"
 services:
   ydb:
-    image: cr.yandex/yc/yandex-docker-local-ydb:latest
+    image: cr.yandex/yc/yandex-docker-local-ydb@sha256:b569c23d6854564ec4d970bda86cddcf5b11c7c6362df62beb8ba8eafb8d54fd
     restart: always
     ports:
       - 2136:2136

examples/_sqlalchemy_example/example.py

@@ -0,0 +1,229 @@
+import datetime
+import logging
+import argparse
+import sqlalchemy as sa
+from sqlalchemy import orm, exc, sql
+from sqlalchemy import Table, Column, Integer, String, Float, TIMESTAMP
+from ydb._sqlalchemy import register_dialect
+
+from fill_tables import fill_all_tables, to_days
+from models import Base, Series, Episodes
+
+
+def describe_table(engine, name):
+    inspect = sa.inspect(engine)
+    print(f"describe table {name}:")
+    for col in inspect.get_columns(name):
+        print(f"\t{col['name']}: {col['type']}")
+
+
+def simple_select(conn):
+    stm = sa.select(Series).where(Series.series_id == 1)
+    res = conn.execute(stm)
+    print(res.one())
+
+
+def simple_insert(conn):
+    stm = Episodes.__table__.insert().values(
+        series_id=3, season_id=6, episode_id=1, title="TBD"
+    )
+    conn.execute(stm)
+
+
+def test_types(conn):
+    types_tb = Table(
+        "test_types",
+        Base.metadata,
+        Column("id", Integer, primary_key=True),
+        Column("str", String),
+        Column("num", Float),
+        Column("dt", TIMESTAMP),
+    )
+    types_tb.drop(bind=conn.engine, checkfirst=True)
+    types_tb.create(bind=conn.engine, checkfirst=True)
+
+    stm = types_tb.insert().values(
+        id=1,
+        str=b"Hello World!",
+        num=3.1415,
+        dt=datetime.datetime.now(),
+    )
+    conn.execute(stm)
+
+    # GROUP BY
+    stm = sa.select(types_tb.c.str, sa.func.max(types_tb.c.num)).group_by(
+        types_tb.c.str
+    )
+    rs = conn.execute(stm)
+    for x in rs:
+        print(x)
+
+
+def run_example_orm(engine):
+    Base.metadata.bind = engine
+    Base.metadata.drop_all()
+    Base.metadata.create_all()
+
+    session = orm.sessionmaker(bind=engine)()
+
+    rs = session.query(Episodes).all()
+    for e in rs:
+        print(f"{e.episode_id}: {e.title}")
+
+    fill_all_tables(session.connection())
+
+    try:
+        session.add_all(
+            [
+                Episodes(
+                    series_id=2,
+                    season_id=1,
+                    episode_id=1,
+                    title="Minimum Viable Product",
+                    air_date=to_days("2014-04-06"),
+                ),
+                Episodes(
+                    series_id=2,
+                    season_id=1,
+                    episode_id=2,
+                    title="The Cap Table",
+                    air_date=to_days("2014-04-13"),
+                ),
+                Episodes(
+                    series_id=2,
+                    season_id=1,
+                    episode_id=3,
+                    title="Articles of Incorporation",
+                    air_date=to_days("2014-04-20"),
+                ),
+                Episodes(
+                    series_id=2,
+                    season_id=1,
+                    episode_id=4,
+                    title="Fiduciary Duties",
+                    air_date=to_days("2014-04-27"),
+                ),
+                Episodes(
+                    series_id=2,
+                    season_id=1,
+                    episode_id=5,
+                    title="Signaling Risk",
+                    air_date=to_days("2014-05-04"),
+                ),
+            ]
+        )
+        session.commit()
+    except exc.DatabaseError:
+        print("Episodes already added!")
+        session.rollback()
+
+    rs = session.query(Episodes).all()
+    for e in rs:
+        print(f"{e.episode_id}: {e.title}")
+
+    rs = session.query(Episodes).filter(Episodes.title == "abc??").all()
+    for e in rs:
+        print(e.title)
+
+    print("Episodes count:", session.query(Episodes).count())
+
+    max_episode = session.query(sql.expression.func.max(Episodes.episode_id)).scalar()
+    print("Maximum episodes id:", max_episode)
+
+    session.add(
+        Episodes(
+            series_id=2,
+            season_id=1,
+            episode_id=max_episode + 1,
+            title="Signaling Risk",
+            air_date=to_days("2014-05-04"),
+        )
+    )
+
+    print("Episodes count:", session.query(Episodes).count())
+
+
+def run_example_core(engine):
+    with engine.connect() as conn:
+        # raw sql
+        rs = conn.execute("SELECT 1 AS value")
+        print(rs.fetchone()["value"])
+
+        fill_all_tables(conn)
+
+        for t in "series seasons episodes".split():
+            describe_table(engine, t)
+
+        tb = sa.Table("episodes", sa.MetaData(engine), autoload=True)
+        stm = (
+            sa.select([tb.c.title])
+            .where(sa.and_(tb.c.series_id == 1, tb.c.season_id == 3))
+            .where(tb.c.title.like("%"))
+            .order_by(sa.asc(tb.c.title))
+            # TODO: limit isn't working now
+            # .limit(3)
+        )
+        rs = conn.execute(stm)
+        print(rs.fetchall())
+
+        simple_select(conn)
+
+        simple_insert(conn)
+
+        # simple join
+        stm = sa.select(
+            [Episodes.__table__.join(Series, Episodes.series_id == Series.series_id)]
+        ).where(sa.and_(Series.series_id == 1, Episodes.season_id == 1))
+        rs = conn.execute(stm)
+        for row in rs:
+            print(f"{row.series_title}({row.episode_id}): {row.title}")
+
+        rs = conn.execute(sa.select(Episodes).where(Episodes.series_id == 3))
+        print(rs.fetchall())
+
+        # count
+        cnt = conn.execute(sa.func.count(Episodes.episode_id)).scalar()
+        print("Episodes cnt:", cnt)
+
+        # simple delete
+        conn.execute(sa.delete(Episodes).where(Episodes.title == "TBD"))
+        cnt = conn.execute(sa.func.count(Episodes.episode_id)).scalar()
+        print("Episodes cnt:", cnt)
+
+        test_types(conn)
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        description="""\033[92mYandex.Database examples sqlalchemy usage.\x1b[0m\n""",
+    )
+    parser.add_argument(
+        "-d",
+        "--database",
+        help="Name of the database to use",
+        default="/local",
+    )
+    parser.add_argument(
+        "-e",
+        "--endpoint",
+        help="Endpoint url to use",
+        default="grpc://localhost:2136",
+    )
+
+    args = parser.parse_args()
+    register_dialect()
+    engine = sa.create_engine(
+        "yql:///ydb/",
+        connect_args={"database": args.database, "endpoint": args.endpoint},
+    )
+
+    logging.basicConfig(level=logging.INFO)
+    logging.getLogger("_sqlalchemy.engine").setLevel(logging.INFO)
+
+    run_example_core(engine)
+    # run_example_orm(engine)
+
+
+if __name__ == "__main__":
+    main()