edgedb-python 1.6.1

.github/workflows/install-edgedb.sh

@@ -5,15 +5,20 @@ shopt -s nullglob
 
 srv="https://packages.edgedb.com"
 
-curl -fL "${srv}/dist/x86_64-unknown-linux-musl/edgedb-cli" \
-    > "/usr/local/bin/edgedb"
+curl -fL "${srv}/dist/$(uname -m)-unknown-linux-musl/edgedb-cli" \
+    > "/usr/bin/edgedb"
 
-chmod +x "/usr/local/bin/edgedb"
+chmod +x "/usr/bin/edgedb"
 
-useradd --shell /bin/bash edgedb
+if command -v useradd >/dev/null 2>&1; then
+    useradd --shell /bin/bash edgedb
+else
+    # musllinux/alpine doesn't have useradd
+    adduser -s /bin/bash -D edgedb
+fi
 
 su -l edgedb -c "edgedb server install"
 ln -s $(su -l edgedb -c "edgedb server info --latest --bin-path") \
-    "/usr/local/bin/edgedb-server"
+    "/usr/bin/edgedb-server"
 
 edgedb-server --version

.github/workflows/release.yml

@@ -5,7 +5,8 @@ on:
     branches:
       - "master"
       - "ci"
-      - "[0-9]+.[0-9x]+*"
+      - "release/[0-9]+.x"
+      - "release/[0-9]+.[0-9]+.x"
     paths:
       - "edgedb/_version.py"
 
@@ -39,7 +40,7 @@ jobs:
         mkdir -p dist/
         echo "${VERSION}" > dist/VERSION
 
-    - uses: actions/upload-artifact@v2
+    - uses: actions/upload-artifact@v3
       with:
         name: dist
         path: dist/
@@ -52,7 +53,7 @@ jobs:
       PIP_DISABLE_PIP_VERSION_CHECK: 1
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         fetch-depth: 50
         submodules: true
@@ -65,19 +66,43 @@ jobs:
         pip install -U setuptools wheel pip
         python setup.py sdist
 
-    - uses: actions/upload-artifact@v2
+    - uses: actions/upload-artifact@v3
       with:
         name: dist
         path: dist/*.tar.*
 
-  build-wheels:
+  build-wheels-matrix:
     needs: validate-release-request
+    runs-on: ubuntu-latest
+    outputs:
+      include: ${{ steps.set-matrix.outputs.include }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+      - run: pip install cibuildwheel==2.19.2
+      - id: set-matrix
+        # Cannot test on Musl distros yet.
+        env:
+          CIBW_SKIP: "cp312-*"
+        run: |
+          MATRIX_INCLUDE=$(
+            {
+              cibuildwheel --print-build-identifiers --platform linux --arch x86_64,aarch64 | grep cp | grep many |  jq -nRc '{"only": inputs, "os": "ubuntu-latest"}' \
+              && cibuildwheel --print-build-identifiers --platform macos --arch x86_64,arm64 | grep cp |  jq -nRc '{"only": inputs, "os": "macos-latest"}' \
+              && cibuildwheel --print-build-identifiers --platform windows --arch AMD64 | grep cp |  jq -nRc '{"only": inputs, "os": "windows-2019"}'
+            } | jq -sc
+          )
+          echo "include=$MATRIX_INCLUDE" >> $GITHUB_OUTPUT
+  build-wheels:
+    needs: build-wheels-matrix
     runs-on: ${{ matrix.os }}
+    name: Build ${{ matrix.only }}
     strategy:
+      fail-fast: false
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-2019]
-        cibw_python: ["cp37-*", "cp38-*", "cp39-*", "cp310-*"]
-        cibw_arch: ["auto64"]
+        include: ${{ fromJson(needs.build-wheels-matrix.outputs.include) }}
 
     defaults:
       run:
@@ -87,32 +112,32 @@ jobs:
       PIP_DISABLE_PIP_VERSION_CHECK: 1
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         fetch-depth: 50
         submodules: true
 
     - name: Setup WSL
-      if: ${{ steps.release.outputs.version == 0 && matrix.os == 'windows-2019' }}
-      uses: vampire/setup-wsl@v1
+      if: ${{ matrix.os == 'windows-2019' }}
+      uses: vampire/setup-wsl@v2
       with:
         wsl-shell-user: edgedb
         additional-packages:
           ca-certificates
           curl
 
+    - name: Set up QEMU
+      if: runner.os == 'Linux'
+      uses: docker/setup-qemu-action@v2
+
     - name: Install EdgeDB
       uses: edgedb/setup-edgedb@v1
 
-    - uses: pypa/[email protected]
+    - uses: pypa/[email protected]
+      with:
+          only: ${{ matrix.only }}
       env:
         CIBW_BUILD_VERBOSITY: 1
-        CIBW_BUILD: ${{ matrix.cibw_python }}
-        # Cannot test on Musl distros yet.
-        CIBW_SKIP: "*-musllinux*"
-        CIBW_ARCHS: ${{ matrix.cibw_arch }}
-        # EdgeDB doesn't run on CentOS 6, so use 2014 as baseline
-        CIBW_MANYLINUX_X86_64_IMAGE: "quay.io/pypa/manylinux2014_x86_64"
         CIBW_BEFORE_ALL_LINUX: >
           .github/workflows/install-edgedb.sh
         CIBW_TEST_EXTRAS: "test"
@@ -126,22 +151,24 @@ jobs:
           && chmod -R go+rX "$(dirname $(dirname $(dirname $PY)))"
           && su -l edgedb -c "EDGEDB_PYTHON_TEST_CODEGEN_CMD=$CODEGEN $PY {project}/tests/__init__.py"
 
-    - uses: actions/upload-artifact@v2
+    - uses: actions/upload-artifact@v3
       with:
         name: dist
         path: wheelhouse/*.whl
 
   publish:
     needs: [build-sdist, build-wheels]
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         fetch-depth: 5
         submodules: false
 
-    - uses: actions/download-artifact@v2
+    - uses: actions/download-artifact@v3
       with:
         name: dist
         path: dist/

.github/workflows/tests.yml

@@ -23,15 +23,27 @@ jobs:
       PIP_DISABLE_PIP_VERSION_CHECK: 1
 
     strategy:
+      fail-fast: false
       matrix:
         python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
         edgedb-version: [stable , nightly]
-        os: [ubuntu-latest, macos-latest, windows-2019]
+        os: [ubuntu-20.04, ubuntu-latest, macos-latest, windows-2019]
         loop: [asyncio, uvloop]
         exclude:
           # uvloop does not support windows
           - loop: uvloop
             os: windows-2019
+          # Python 3.7 on ubuntu-22.04 has a broken OpenSSL 3.0
+          - python-version: 3.7
+            os: ubuntu-latest
+          - python-version: 3.8
+            os: ubuntu-20.04
+          - python-version: 3.9
+            os: ubuntu-20.04
+          - python-version: 3.10
+            os: ubuntu-20.04
+          - python-version: 3.11
+            os: ubuntu-20.04
 
     steps:
     - uses: actions/checkout@v2
@@ -70,7 +82,7 @@ jobs:
         server-version: ${{ matrix.edgedb-version }}
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       if: steps.release.outputs.version == 0
       with:
         python-version: ${{ matrix.python-version }}

docs/api/asyncio_client.rst

@@ -15,6 +15,7 @@ Client
 .. py:function:: create_async_client(dsn=None, *, \
             host=None, port=None, \
             user=None, password=None, \
+            secret_key=None, \
             database=None, \
             timeout=60, \
             concurrency=None)
@@ -44,26 +45,16 @@ Client
         the :ref:`DSN Specification <ref_dsn>`.
 
     :param host:
-        Database host address as one of the following:
-
-        - an IP address or a domain name;
-        - an absolute path to the directory containing the database
-          server Unix-domain socket (not supported on Windows);
-        - a sequence of any of the above, in which case the addresses
-          will be tried in order, and the host of the first successful
-          connection will be used for the whole connection pool.
+        Database host address as an IP address or a domain name;
 
         If not specified, the following will be tried, in order:
 
         - host address(es) parsed from the *dsn* argument,
         - the value of the ``EDGEDB_HOST`` environment variable,
-        - on Unix, common directories used for EdgeDB Unix-domain
-          sockets: ``"/run/edgedb"`` and ``"/var/run/edgedb"``,
         - ``"localhost"``.
 
     :param port:
-        Port number to connect to at the server host
-        (or Unix-domain socket file extension).  If multiple host
+        Port number to connect to at the server host. If multiple host
         addresses were specified, this parameter may specify a
         sequence of port numbers of the same length as the host sequence,
         or it may specify a single port number to be used for all host
@@ -95,6 +86,14 @@ Client
         other users and applications may be able to read it without needing
         specific privileges.
 
+    :param secret_key:
+        Secret key to be used for authentication, if the server requires one.
+        If not specified, the value parsed from the *dsn* argument is used,
+        or the value of the ``EDGEDB_SECRET_KEY`` environment variable.
+        Note that the use of the environment variable is discouraged as
+        other users and applications may be able to read it without needing
+        specific privileges.
+
     :param float timeout:
         Connection timeout in seconds.
 
@@ -558,8 +557,8 @@ transaction), so we have to redo all the work done.
 Generally it's recommended to not execute any long running
 code within the transaction unless absolutely necessary.
 
-Transactions allocate expensive server resources and having
-too many concurrently running long-running transactions will
+Transactions allocate expensive server resources, and having
+too many concurrent long-running transactions will
 negatively impact the performance of the DB server.
 
 To rollback a transaction that is in progress raise an exception.

docs/api/blocking_client.rst

@@ -15,6 +15,7 @@ Client
 .. py:function:: create_client(dsn=None, *, \
             host=None, port=None, \
             user=None, password=None, \
+            secret_key=None, \
             database=None, \
             timeout=60, \
             concurrency=None)
@@ -44,26 +45,16 @@ Client
         the :ref:`DSN Specification <ref_dsn>`.
 
     :param host:
-        Database host address as one of the following:
-
-        - an IP address or a domain name;
-        - an absolute path to the directory containing the database
-          server Unix-domain socket (not supported on Windows);
-        - a sequence of any of the above, in which case the addresses
-          will be tried in order, and the host of the first successful
-          connection will be used for the whole connection pool.
+        Database host address as an IP address or a domain name;
 
         If not specified, the following will be tried, in order:
 
         - host address(es) parsed from the *dsn* argument,
         - the value of the ``EDGEDB_HOST`` environment variable,
-        - on Unix, common directories used for EdgeDB Unix-domain
-          sockets: ``"/run/edgedb"`` and ``"/var/run/edgedb"``,
         - ``"localhost"``.
 
     :param port:
-        Port number to connect to at the server host
-        (or Unix-domain socket file extension).  If multiple host
+        Port number to connect to at the server host. If multiple host
         addresses were specified, this parameter may specify a
         sequence of port numbers of the same length as the host sequence,
         or it may specify a single port number to be used for all host
@@ -95,6 +86,14 @@ Client
         other users and applications may be able to read it without needing
         specific privileges.
 
+    :param secret_key:
+        Secret key to be used for authentication, if the server requires one.
+        If not specified, the value parsed from the *dsn* argument is used,
+        or the value of the ``EDGEDB_SECRET_KEY`` environment variable.
+        Note that the use of the environment variable is discouraged as
+        other users and applications may be able to read it without needing
+        specific privileges.
+
     :param float timeout:
         Connection timeout in seconds.
 

docs/index.rst

@@ -32,6 +32,10 @@ and :ref:`asyncio <edgedb-python-asyncio-api-reference>` implementations.
 
   EdgeDB Python types documentation.
 
+* :ref:`edgedb-python-codegen`
+
+  Python code generation command-line tool documentation.
+
 * :ref:`edgedb-python-advanced`
 
   Advanced usages of the state and optional customization.

docs/usage.rst

@@ -78,8 +78,8 @@ types and vice versa.  See :ref:`edgedb-python-datatypes` for details.
 Client connection pools
 -----------------------
 
-For server-type type applications that handle frequent requests and need
-the database connection for a short period time while handling a request,
+For server-type applications that handle frequent requests and need
+the database connection for a short period of time while handling a request,
 the use of a connection pool is recommended. Both :py:class:`edgedb.Client`
 and :py:class:`edgedb.AsyncIOClient` come with such a pool.