From 98641e02ef4856d7f546a70a0728716eec5d07ae Mon Sep 17 00:00:00 2001 From: Yury Selivanov Date: Fri, 14 Feb 2025 19:51:03 -0800 Subject: [PATCH] More refs --- docs/changelog/1_0_a2.rst | 2 +- docs/changelog/1_0_a5.rst | 2 +- docs/changelog/2_x.rst | 6 +++--- docs/cli/edgedb.rst | 2 +- docs/cli/edgedb_analyze.rst | 2 +- docs/clients/connection.rst | 6 +++--- docs/clients/go/index.rst | 2 +- docs/clients/graphql/index.rst | 2 +- docs/clients/js/delete.rst | 2 +- docs/clients/js/driver.rst | 10 +++++----- docs/clients/js/for.rst | 16 ++++++++-------- docs/clients/js/funcops.rst | 8 ++++---- docs/clients/js/generation.rst | 14 +++++++------- docs/clients/js/group.rst | 2 +- docs/clients/js/index.rst | 14 +++++++------- docs/clients/js/insert.rst | 6 +++--- docs/clients/js/interfaces.rst | 2 +- docs/clients/js/literals.rst | 4 ++-- docs/clients/js/objects.rst | 4 ++-- docs/clients/js/parameters.rst | 4 ++-- docs/clients/js/queries.rst | 4 ++-- docs/clients/js/querybuilder.rst | 14 +++++++------- docs/clients/js/reference.rst | 10 +++++----- docs/clients/js/select.rst | 6 +++--- docs/clients/js/types.rst | 4 ++-- docs/clients/js/update.rst | 10 +++++----- docs/clients/js/with.rst | 2 +- docs/clients/python/api/advanced.rst | 8 ++++---- docs/clients/python/api/asyncio_client.rst | 16 ++++++++-------- docs/clients/python/api/blocking_client.rst | 16 ++++++++-------- docs/clients/python/api/codegen.rst | 2 +- docs/clients/python/api/types.rst | 6 +++--- docs/clients/python/index.rst | 20 ++++++++++---------- docs/clients/python/installation.rst | 2 +- docs/clients/python/usage.rst | 18 +++++++++--------- docs/edgeql/transactions.rst | 6 +++--- docs/guides/deployment/digitalocean.rst | 8 ++++---- docs/guides/deployment/fly_io.rst | 4 ++-- docs/guides/deployment/heroku.rst | 2 +- docs/guides/tutorials/chatgpt_bot.rst | 2 +- docs/intro/clients.rst | 6 +++--- docs/intro/edgeql.rst | 2 +- docs/intro/quickstart.rst | 12 ++++++------ 43 files changed, 145 insertions(+), 145 deletions(-) diff --git a/docs/changelog/1_0_a2.rst b/docs/changelog/1_0_a2.rst index d92534bd6d0..f83010a371f 100644 --- a/docs/changelog/1_0_a2.rst +++ b/docs/changelog/1_0_a2.rst @@ -47,7 +47,7 @@ and it is ready for use: main(); -The documentation can be found :ref:`here `. +The documentation can be found :ref:`here `. Standard Library diff --git a/docs/changelog/1_0_a5.rst b/docs/changelog/1_0_a5.rst index 7de1a2b48a6..dd4e9307d5f 100644 --- a/docs/changelog/1_0_a5.rst +++ b/docs/changelog/1_0_a5.rst @@ -108,7 +108,7 @@ CLI Bindings ======== -* Add transaction :ref:`API ` to JS binding +* Add transaction :ref:`API ` to JS binding (`#61 `_). Here's an example of using transactions: diff --git a/docs/changelog/2_x.rst b/docs/changelog/2_x.rst index 95c5160041d..76d309581d3 100644 --- a/docs/changelog/2_x.rst +++ b/docs/changelog/2_x.rst @@ -93,11 +93,11 @@ upgrade. .. list-table:: - * - :ref:`TypeScript/JS ` + * - :ref:`TypeScript/JS ` - ``edgedb@0.21.0`` - * - :ref:`Python ` + * - :ref:`Python ` - ``edgedb@0.24.0`` - * - :ref:`Golang ` + * - :ref:`Golang ` - ``edgedb@0.12.0`` * - `Rust `_ - ``edgedb-tokio@0.3.0`` diff --git a/docs/cli/edgedb.rst b/docs/cli/edgedb.rst index e6b5a2a156b..316f8cd1f60 100644 --- a/docs/cli/edgedb.rst +++ b/docs/cli/edgedb.rst @@ -1,4 +1,4 @@ -.. _ref_cli_edgedb: +.. _ref_cli_gel: === gel diff --git a/docs/cli/edgedb_analyze.rst b/docs/cli/edgedb_analyze.rst index 923d8197583..0af49e6df7d 100644 --- a/docs/cli/edgedb_analyze.rst +++ b/docs/cli/edgedb_analyze.rst @@ -8,7 +8,7 @@ gel analyze .. note:: Performance analysis is also available in our :ref:`CLI REPL - ` and the UI's REPL and query builder (both accessible by + ` and the UI's REPL and query builder (both accessible by running :ref:`ref_cli_gel_ui` to invoke your instance's UI). Use it by prepending your query with ``analyze``. diff --git a/docs/clients/connection.rst b/docs/clients/connection.rst index 49023e2f100..d8cd8d0f117 100644 --- a/docs/clients/connection.rst +++ b/docs/clients/connection.rst @@ -1,4 +1,4 @@ -.. _edgedb_client_connection: +.. _gel_client_connection: ========== Connection @@ -22,7 +22,7 @@ library. - Set the ``EDGEDB_INSTANCE`` environment variable to a :ref:`name ` of a local instance, remote linked instance, or an |Gel| Cloud instance. (:ref:`More info on |Gel| Cloud - connection details below. `) You can create + connection details below. `) You can create new instances manually with the :ref:`gel instance create ` command. @@ -49,7 +49,7 @@ supports several other options for advanced use cases. For a complete reference on connection configuration, see :ref:`Reference > Connection Parameters `. -.. _edgedb_client_connection_cloud: +.. _gel_client_connection_cloud: Gel Cloud ========= diff --git a/docs/clients/go/index.rst b/docs/clients/go/index.rst index 4f33a9ae224..506353d647b 100644 --- a/docs/clients/go/index.rst +++ b/docs/clients/go/index.rst @@ -1,4 +1,4 @@ -.. _edgedb-go-intro: +.. _gel-go-intro: ============= Gel Go Driver diff --git a/docs/clients/graphql/index.rst b/docs/clients/graphql/index.rst index 8477ebce594..43ac4567762 100644 --- a/docs/clients/graphql/index.rst +++ b/docs/clients/graphql/index.rst @@ -39,7 +39,7 @@ Then create a new migration and apply it. $ gel migration create $ gel migrate -Refer to the :ref:`connection docs ` for various +Refer to the :ref:`connection docs ` for various methods of running these commands against remotely-hosted instances. Connection diff --git a/docs/clients/js/delete.rst b/docs/clients/js/delete.rst index c299a3b1791..7317839da26 100644 --- a/docs/clients/js/delete.rst +++ b/docs/clients/js/delete.rst @@ -1,4 +1,4 @@ -.. _edgedb-js-delete: +.. _gel-js-delete: Delete ------ diff --git a/docs/clients/js/driver.rst b/docs/clients/js/driver.rst index 3d5a2afe05d..7304ee9e019 100644 --- a/docs/clients/js/driver.rst +++ b/docs/clients/js/driver.rst @@ -1,4 +1,4 @@ -.. _edgedb-js-driver: +.. _gel-js-driver: Client @@ -7,7 +7,7 @@ Client The ``Client`` class implements the basic functionality required to establish a connection to your database and execute queries. -.. _edgedb-js-create-client: +.. _gel-js-create-client: Creating clients ---------------- @@ -114,7 +114,7 @@ To execute a basic query: } -.. _edgedb-js-typescript: +.. _gel-js-typescript: In TypeScript, you can supply a type hint to receive a strongly typed result. @@ -377,7 +377,7 @@ a query, use the ``.ensureConnected()`` method. await client.ensureConnected(); } -.. _edgedb-js-api-transaction: +.. _gel-js-api-transaction: Transactions ------------ @@ -455,7 +455,7 @@ Next up ------- If you're a TypeScript user and want autocompletion and type inference, head -over to the :ref:`Query Builder docs `. If you're using plain +over to the :ref:`Query Builder docs `. If you're using plain JavaScript that likes writing queries with composable code-first syntax, you should check out the query builder too! If you're content writing queries as strings, the vanilla Client API will meet your needs. diff --git a/docs/clients/js/for.rst b/docs/clients/js/for.rst index ca80a7cea6a..2a71c09154d 100644 --- a/docs/clients/js/for.rst +++ b/docs/clients/js/for.rst @@ -1,4 +1,4 @@ -.. _edgedb-js-for: +.. _gel-js-for: For Loops @@ -14,7 +14,7 @@ For Loops const result = query.run(client); // [2, 4, 8, 16] -.. _edgedb-js-for-bulk-inserts: +.. _gel-js-for-bulk-inserts: Bulk inserts ------------ @@ -47,7 +47,7 @@ Note that any optional properties values must be explicitly set to ``null``. They cannot be set to ``undefined`` or omitted; doing so will cause a runtime error. -.. _edgedb-js-for-bulk-inserts-conflicts: +.. _gel-js-for-bulk-inserts-conflicts: Handling conflicts in bulk inserts ---------------------------------- @@ -158,7 +158,7 @@ down. } ); -.. _edgedb-js-for-bulk-inserts-conflicts-params: +.. _gel-js-for-bulk-inserts-conflicts-params: Structured params ~~~~~~~~~~~~~~~~~ @@ -187,7 +187,7 @@ objects as named tuples by passing an object to ``e.tuple`` — all the data in the array will be properly cast for us. It will also better type check the data you pass to the query's ``run`` method. -.. _edgedb-js-for-bulk-inserts-conflicting-data: +.. _gel-js-for-bulk-inserts-conflicting-data: Inserting the inner conflicting data ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -228,7 +228,7 @@ database *before* we run this query, but it won't handle conflicts that come about over the course of this query. The ``distinct`` operator we used earlier pro-actively eliminates any conflicts we might have had among this data. -.. _edgedb-js-for-bulk-inserts-outer-data: +.. _gel-js-for-bulk-inserts-outer-data: Inserting the outer data ~~~~~~~~~~~~~~~~~~~~~~~~ @@ -271,7 +271,7 @@ that match values in the ``character.movies`` array. All that's left is to run the query, passing the data to the query's ``run`` method! -.. _edgedb-js-for-bulk-updates: +.. _gel-js-for-bulk-updates: Bulk updates ^^^^^^^^^^^^ @@ -334,7 +334,7 @@ In addition to the performance implications, a single query means that either everything succeeds or everything fails. You will never end up with only some of your data inserted. This ensures your data integrity is maintained. You could achieve this yourself by wrapping your batch queryies with :ref:`a -transaction `, but a single query is already atomic +transaction `, but a single query is already atomic without any additional work on your part. Using ``e.for`` to run a single query is generally the best approach. When diff --git a/docs/clients/js/funcops.rst b/docs/clients/js/funcops.rst index fd38ef4054f..fe0530973dc 100644 --- a/docs/clients/js/funcops.rst +++ b/docs/clients/js/funcops.rst @@ -1,4 +1,4 @@ -.. _edgedb-js-funcops: +.. _gel-js-funcops: Functions and Operators ----------------------- @@ -24,7 +24,7 @@ All built-in standard library functions are reflected as functions in ``e``. // math::mean({3, 5, 7}) -.. _edgedb-js-funcops-prefix: +.. _gel-js-funcops-prefix: Prefix operators ^^^^^^^^^^^^^^^^ @@ -45,7 +45,7 @@ Prefix operators operate on a single argument: ``OPERATOR ``. * - ``"exists"`` ``"distinct"`` ``"not"`` -.. _edgedb-js-funcops-infix: +.. _gel-js-funcops-infix: Infix operators ^^^^^^^^^^^^^^^ @@ -65,7 +65,7 @@ Infix operators operate on two arguments: `` OPERATOR ``. ``"ilike"`` ``"not like"`` ``"not ilike"`` -.. _edgedb-js-funcops-ternary: +.. _gel-js-funcops-ternary: Ternary operators ^^^^^^^^^^^^^^^^^ diff --git a/docs/clients/js/generation.rst b/docs/clients/js/generation.rst index aa09c28788a..bcabcb444b8 100644 --- a/docs/clients/js/generation.rst +++ b/docs/clients/js/generation.rst @@ -1,4 +1,4 @@ -.. _edgedb-js-generators: +.. _gel-js-generators: Generators ========== @@ -10,7 +10,7 @@ TypeScript/JavaScript. To get started with generators, first initialize an :ref:`Gel project ` in the root of your application. Generators will look for an |gel.toml| file to determine the root of your application. See -the :ref:`Overview ` page for details on installing. +the :ref:`Overview ` page for details on installing. .. note:: @@ -57,18 +57,18 @@ The value of ```` should be one of the following: - Generates the query builder which provides a **code-first** way to write **fully-typed** EdgeQL queries with TypeScript. We recommend it for TypeScript users, or anyone who prefers writing queries with code. - - :ref:`docs ` + - :ref:`docs ` * - ``queries`` - Scans your project for ``*.edgeql`` files and generates functions that allow you to execute these queries in a typesafe way. - - :ref:`docs ` + - :ref:`docs ` * - ``interfaces`` - Introspects your schema and generates file containing *TypeScript interfaces* that correspond to each object type. This is useful for writing typesafe code to interact with |Gel|. - - :ref:`docs ` + - :ref:`docs ` Connection ^^^^^^^^^^ @@ -87,9 +87,9 @@ analyzer in JavaScript—which we don't intend to do anytime soon. If you're using :gelcmd:`project init`, the connection is automatically handled for you. Otherwise, you'll need to explicitly pass connection information via environment variables or CLI flags, just like any other CLI command. See -:ref:`Client Libraries > Connection ` for guidance. +:ref:`Client Libraries > Connection ` for guidance. -.. _edgedb_qb_target: +.. _gel_qb_target: Targets ^^^^^^^ diff --git a/docs/clients/js/group.rst b/docs/clients/js/group.rst index 4ddec308a1f..deb9d27b8f2 100644 --- a/docs/clients/js/group.rst +++ b/docs/clients/js/group.rst @@ -1,4 +1,4 @@ -.. _edgedb-js-group: +.. _gel-js-group: Group ===== diff --git a/docs/clients/js/index.rst b/docs/clients/js/index.rst index fc75f7fcd41..8672831eaa5 100644 --- a/docs/clients/js/index.rst +++ b/docs/clients/js/index.rst @@ -1,4 +1,4 @@ -.. _edgedb-js-intro: +.. _gel-js-intro: ======================== Gel TypeScript/JS Client @@ -27,7 +27,7 @@ Gel TypeScript/JS Client group reference -.. _edgedb-js-installation: +.. _gel-js-installation: Installation @@ -89,7 +89,7 @@ generators from npm using your package manager of choice. } -.. _edgedb-js-quickstart: +.. _gel-js-quickstart: Quickstart ========== @@ -225,7 +225,7 @@ Interfaces Since we're using TypeScript, it would be nice to be able to type the return value of this query, so let's use our first generator, the :ref:`interfaces -generator ` to tell TypeScript what the type of our result +generator ` to tell TypeScript what the type of our result is. First we run the generator: @@ -277,7 +277,7 @@ Queries generator Wouldn't it be great if we could write any arbitrary query and get a type-safe function that we could call? Good news, that's exactly what the next generator -does! The :ref:`queries generator ` scans your project for +does! The :ref:`queries generator ` scans your project for ``*.edgeql`` files and generates a file containing a strongly-typed function. First, move the query into a separate file called ``getMovie.edgeql``. @@ -396,8 +396,8 @@ in TypeScript, getting editor completion, type checking, and type inferrence: What's next =========== -We recommend reading the :ref:`client docs ` first and getting +We recommend reading the :ref:`client docs ` first and getting familiar with configuring the client. You'll find important APIs like ``withGlobals`` and connection details there. After that, depending on your -preferences, look through the :ref:`query builder ` documentation +preferences, look through the :ref:`query builder ` documentation and use the other pages as a reference for writing code-first Gel queries. diff --git a/docs/clients/js/insert.rst b/docs/clients/js/insert.rst index 1f8cff329cb..37fbf7df5bb 100644 --- a/docs/clients/js/insert.rst +++ b/docs/clients/js/insert.rst @@ -1,4 +1,4 @@ -.. _edgedb-js-insert: +.. _gel-js-insert: Insert ------ @@ -158,5 +158,5 @@ properties in a tuple. Bulk inserts ^^^^^^^^^^^^ -You can use a :ref:`for loop ` to perform :ref:`bulk inserts -`. +You can use a :ref:`for loop ` to perform :ref:`bulk inserts +`. diff --git a/docs/clients/js/interfaces.rst b/docs/clients/js/interfaces.rst index 0c6380b4a8d..7bc69dc9af2 100644 --- a/docs/clients/js/interfaces.rst +++ b/docs/clients/js/interfaces.rst @@ -1,4 +1,4 @@ -.. _edgedb-js-interfaces: +.. _gel-js-interfaces: ==================== Interfaces Generator diff --git a/docs/clients/js/literals.rst b/docs/clients/js/literals.rst index 90983b309f3..1e6d7272dcd 100644 --- a/docs/clients/js/literals.rst +++ b/docs/clients/js/literals.rst @@ -1,4 +1,4 @@ -.. _edgedb-js-literals: +.. _gel-js-literals: Literals @@ -90,7 +90,7 @@ type system: ``duration``, ``cal::relative_duration``, ``cal::date_duration``, To resolve this, each of these datatypes can be represented with an instance of a corresponding class, as defined in ``gel`` module. Clients use these classes to represent these values in query results; they are documented -on the :ref:`Client API ` docs. +on the :ref:`Client API ` docs. .. list-table:: diff --git a/docs/clients/js/objects.rst b/docs/clients/js/objects.rst index bf2870cc668..9df71ed7acd 100644 --- a/docs/clients/js/objects.rst +++ b/docs/clients/js/objects.rst @@ -1,4 +1,4 @@ -.. _edgedb-js-objects: +.. _gel-js-objects: Objects and Paths @@ -86,7 +86,7 @@ Paths can be constructed from any object expression, not just the root types. // (insert Movie { title := "Iron Man" }).title -.. _edgedb-js-objects-type-intersections: +.. _gel-js-objects-type-intersections: Type intersections ^^^^^^^^^^^^^^^^^^ diff --git a/docs/clients/js/parameters.rst b/docs/clients/js/parameters.rst index a55bb26f0bf..45f9096b4d2 100644 --- a/docs/clients/js/parameters.rst +++ b/docs/clients/js/parameters.rst @@ -1,4 +1,4 @@ -.. _edgedb-js-parameters: +.. _gel-js-parameters: Parameters ---------- @@ -47,7 +47,7 @@ an expression inside a larger query. wrappedQuery.run(client, {name: "Harry Styles"}); -.. _edgedb-js-optional-parameters: +.. _gel-js-optional-parameters: Optional parameters ^^^^^^^^^^^^^^^^^^^ diff --git a/docs/clients/js/queries.rst b/docs/clients/js/queries.rst index b2b7945d49e..b0a0bdaf905 100644 --- a/docs/clients/js/queries.rst +++ b/docs/clients/js/queries.rst @@ -1,4 +1,4 @@ -.. _edgedb-js-queries: +.. _gel-js-queries: ================= Queries Generator @@ -118,7 +118,7 @@ return type. The generator uses this information to create a new file This example assumes you are using TypeScript. The generator tries to auto-detect the language you're using; you can also specify the language with - the ``--target`` flag. See the :ref:`Targets ` section for + the ``--target`` flag. See the :ref:`Targets ` section for more information. The generated file will look something like this: diff --git a/docs/clients/js/querybuilder.rst b/docs/clients/js/querybuilder.rst index 08e83e9211e..833bd585e90 100644 --- a/docs/clients/js/querybuilder.rst +++ b/docs/clients/js/querybuilder.rst @@ -1,4 +1,4 @@ -.. _edgedb-js-qb: +.. _gel-js-qb: ======================= Query Builder Generator @@ -153,7 +153,7 @@ connection. Generators work by connecting to the database to get information about the current state of the schema. Make sure you run the generators again any time the schema changes so that the generated code is in-sync with the current state of the schema. -.. _edgedb-js-execution: +.. _gel-js-execution: Expressions ----------- @@ -185,8 +185,8 @@ which accepts a ``Client`` instead as the first argument. The result is Note that the ``.run`` method accepts an instance of :js:class:`Client` (or ``Transaction``) as it's first argument. See :ref:`Creating a Client -` for details on creating clients. The second -argument is for passing :ref:`$parameters `, more on +` for details on creating clients. The second +argument is for passing :ref:`$parameters `, more on that later. .. code-block:: typescript @@ -258,7 +258,7 @@ Insert an object // { id: string } // by default INSERT only returns the id of the new object -.. _edgedb-js-qb-transaction: +.. _gel-js-qb-transaction: Transaction ^^^^^^^^^^^ @@ -356,7 +356,7 @@ live alongside your property keys without a risk of collision. The ``e.op`` function is used to express EdgeQL operators. It is documented in more detail below and on the :ref:`Functions and operators - ` page. + ` page. Select a single object ^^^^^^^^^^^^^^^^^^^^^^ @@ -594,7 +594,7 @@ Parameters EdgeQL query with the query builder. -.. _ref_edgedbjs_globals: +.. _ref_geljs_globals: Globals ^^^^^^^ diff --git a/docs/clients/js/reference.rst b/docs/clients/js/reference.rst index d190ab20eef..05485b54abf 100644 --- a/docs/clients/js/reference.rst +++ b/docs/clients/js/reference.rst @@ -1,10 +1,10 @@ -.. _edgedb-js-api-reference: +.. _gel-js-api-reference: ######### Reference ######### -.. _edgedb-js-api-client: +.. _gel-js-api-client: Client ====== @@ -380,7 +380,7 @@ Client transaction, and the backoff timeout between retries can be configured with :js:meth:`Client.withRetryOptions`. - See :ref:`edgedb-js-api-transaction` for more details. + See :ref:`gel-js-api-transaction` for more details. Example: @@ -551,7 +551,7 @@ Client anything. -.. _edgedb-js-datatypes: +.. _gel-js-datatypes: Type conversion =============== @@ -653,7 +653,7 @@ Gel ``array`` maps onto the JavaScript ``Array``. main(); -.. _edgedb-js-types-object: +.. _gel-js-types-object: Objects ======= diff --git a/docs/clients/js/select.rst b/docs/clients/js/select.rst index 4f5d0ac2ebd..9986bf87760 100644 --- a/docs/clients/js/select.rst +++ b/docs/clients/js/select.rst @@ -1,11 +1,11 @@ -.. _edgedb-js-select: +.. _gel-js-select: Select ====== The full power of the EdgeQL ``select`` statement is available as a top-level ``e.select`` function. All queries on this page assume the Netflix schema -described on the :ref:`Objects page `. +described on the :ref:`Objects page `. Selecting scalars ----------------- @@ -418,7 +418,7 @@ Links can be filtered using traditional filters. You can also use the :ref:`type intersection -` operator to filter a link based on its +` operator to filter a link based on its type. For example, since ``actor.roles`` might be of type ``Movie`` or ``TVShow``, to only return ``roles`` that are ``Movie`` types, you would use the ``.is`` type intersection operator: diff --git a/docs/clients/js/types.rst b/docs/clients/js/types.rst index f10fb69eea2..136e8bfe6a9 100644 --- a/docs/clients/js/types.rst +++ b/docs/clients/js/types.rst @@ -1,4 +1,4 @@ -.. _edgedb-js-types-and-casting: +.. _gel-js-types-and-casting: Types @@ -111,7 +111,7 @@ Pass strongly-typed parameters into your query with ``e.params``. The full documentation on using parameters is :ref:`here -`. +`. Polymorphism diff --git a/docs/clients/js/update.rst b/docs/clients/js/update.rst index b3d9a13d922..04d000bf7f8 100644 --- a/docs/clients/js/update.rst +++ b/docs/clients/js/update.rst @@ -1,4 +1,4 @@ -.. _edgedb-js-update: +.. _gel-js-update: Update ------ @@ -27,8 +27,8 @@ You can reference the current value of the object's properties. })) You can conditionally update a property by using an :ref:`optional parameter -` and the :ref:`coalescing infix operator -`. +` and the :ref:`coalescing infix operator +`. .. code-block:: typescript @@ -167,5 +167,5 @@ In the query builder this is represented with the following syntax. Bulk updates ^^^^^^^^^^^^ -You can use a :ref:`for loop ` to perform :ref:`bulk updates -`. +You can use a :ref:`for loop ` to perform :ref:`bulk updates +`. diff --git a/docs/clients/js/with.rst b/docs/clients/js/with.rst index 255922acd1b..28d3977c699 100644 --- a/docs/clients/js/with.rst +++ b/docs/clients/js/with.rst @@ -1,4 +1,4 @@ -.. _edgedb-js-with: +.. _gel-js-with: With Blocks ----------- diff --git a/docs/clients/python/api/advanced.rst b/docs/clients/python/api/advanced.rst index ecb012829e6..aaedeff530d 100644 --- a/docs/clients/python/api/advanced.rst +++ b/docs/clients/python/api/advanced.rst @@ -1,4 +1,4 @@ -.. _edgedb-python-advanced: +.. _gel-python-advanced: ============== Advanced Usage @@ -7,7 +7,7 @@ Advanced Usage .. py:currentmodule:: gel -.. _edgedb-python-transaction-options: +.. _gel-python-transaction-options: Transaction Options =================== @@ -51,7 +51,7 @@ Transaction options are used by the future calls to the method :py:meth:`gel.Client.transaction` or :py:meth:`gel.AsyncIOClient.transaction`. -.. _edgedb-python-retry-options: +.. _gel-python-retry-options: Retry Options ============= @@ -105,7 +105,7 @@ retry options. Both ``self`` and the returned object can be used, but different retry options will applied respectively. -.. _edgedb-python-state: +.. _gel-python-state: State ===== diff --git a/docs/clients/python/api/asyncio_client.rst b/docs/clients/python/api/asyncio_client.rst index ebd8884a9c7..f4e0d1c09c8 100644 --- a/docs/clients/python/api/asyncio_client.rst +++ b/docs/clients/python/api/asyncio_client.rst @@ -1,4 +1,4 @@ -.. _edgedb-python-asyncio-api-reference: +.. _gel-python-asyncio-api-reference: =========== AsyncIO API @@ -7,7 +7,7 @@ AsyncIO API .. py:currentmodule:: gel -.. _edgedb-python-async-api-client: +.. _gel-python-async-api-client: Client ====== @@ -29,7 +29,7 @@ Client If no connection parameter is specified, the client will try to search in environment variables and then the current project, see :ref:`Client - Library Connection ` docs for more information. + Library Connection ` docs for more information. Returns a new :py:class:`AsyncIOClient` object. @@ -329,7 +329,7 @@ Client Returns an instance of :py:class:`AsyncIORetry`. - See :ref:`edgedb-python-asyncio-api-transaction` for more details. + See :ref:`gel-python-asyncio-api-transaction` for more details. Example: @@ -387,7 +387,7 @@ Client :param TransactionOptions options: Object that encapsulates transaction options. - See :ref:`edgedb-python-transaction-options` for details. + See :ref:`gel-python-transaction-options` for details. .. py:method:: with_retry_options(options=None) @@ -395,7 +395,7 @@ Client :param RetryOptions options: Object that encapsulates retry options. - See :ref:`edgedb-python-retry-options` for details. + See :ref:`gel-python-retry-options` for details. .. py:method:: with_state(state) @@ -403,7 +403,7 @@ Client :param State state: Object that encapsulates state. - See :ref:`edgedb-python-state` for details. + See :ref:`gel-python-state` for details. .. py:method:: with_default_module(module=None) @@ -490,7 +490,7 @@ Client See :py:meth:`State.without_globals` for details. -.. _edgedb-python-asyncio-api-transaction: +.. _gel-python-asyncio-api-transaction: Transactions ============ diff --git a/docs/clients/python/api/blocking_client.rst b/docs/clients/python/api/blocking_client.rst index a02f2d36bd9..a43ca779b75 100644 --- a/docs/clients/python/api/blocking_client.rst +++ b/docs/clients/python/api/blocking_client.rst @@ -1,4 +1,4 @@ -.. _edgedb-python-blocking-api-reference: +.. _gel-python-blocking-api-reference: ============ Blocking API @@ -7,7 +7,7 @@ Blocking API .. py:currentmodule:: gel -.. _edgedb-python-blocking-api-client: +.. _gel-python-blocking-api-client: Client ====== @@ -29,7 +29,7 @@ Client If no connection parameter is specified, the client will try to search in environment variables and then the current project, see :ref:`Client - Library Connection ` docs for more information. + Library Connection ` docs for more information. Returns a new :py:class:`Client` object. @@ -325,7 +325,7 @@ Client Returns an instance of :py:class:`Retry`. - See :ref:`edgedb-python-blocking-api-transaction` for more details. + See :ref:`gel-python-blocking-api-transaction` for more details. Example: @@ -383,7 +383,7 @@ Client :param TransactionOptions options: Object that encapsulates transaction options. - See :ref:`edgedb-python-transaction-options` for details. + See :ref:`gel-python-transaction-options` for details. .. py:method:: with_retry_options(options=None) @@ -391,7 +391,7 @@ Client :param RetryOptions options: Object that encapsulates retry options. - See :ref:`edgedb-python-retry-options` for details. + See :ref:`gel-python-retry-options` for details. .. py:method:: with_state(state) @@ -399,7 +399,7 @@ Client :param State state: Object that encapsulates state. - See :ref:`edgedb-python-state` for details. + See :ref:`gel-python-state` for details. .. py:method:: with_default_module(module=None) @@ -486,7 +486,7 @@ Client See :py:meth:`State.without_globals` for details. -.. _edgedb-python-blocking-api-transaction: +.. _gel-python-blocking-api-transaction: Transactions ============ diff --git a/docs/clients/python/api/codegen.rst b/docs/clients/python/api/codegen.rst index f868dd3edf7..bca973455f8 100644 --- a/docs/clients/python/api/codegen.rst +++ b/docs/clients/python/api/codegen.rst @@ -1,4 +1,4 @@ -.. _edgedb-python-codegen: +.. _gel-python-codegen: =============== Code Generation diff --git a/docs/clients/python/api/types.rst b/docs/clients/python/api/types.rst index 3598bce83ee..848d5dda09b 100644 --- a/docs/clients/python/api/types.rst +++ b/docs/clients/python/api/types.rst @@ -1,4 +1,4 @@ -.. _edgedb-python-datatypes: +.. _gel-python-datatypes: ========= Datatypes @@ -74,7 +74,7 @@ The table below shows the correspondence between Gel and Python types. to ``float64`` or ``decimal`` in your query. -.. _edgedb-python-types-set: +.. _gel-python-types-set: Sets ==== @@ -84,7 +84,7 @@ Sets This is :py:class:`list ` since version 1.0. -.. _edgedb-python-types-object: +.. _gel-python-types-object: Objects ======= diff --git a/docs/clients/python/index.rst b/docs/clients/python/index.rst index 874d934117c..c4c54079ad1 100644 --- a/docs/clients/python/index.rst +++ b/docs/clients/python/index.rst @@ -1,42 +1,42 @@ -.. _edgedb-python-intro: +.. _gel-python-intro: ================= Gel Python Driver ================= **gel-python** is the official |Gel| driver for Python. -It provides both :ref:`blocking IO ` -and :ref:`asyncio ` implementations. +It provides both :ref:`blocking IO ` +and :ref:`asyncio ` implementations. .. rubric:: Contents -* :ref:`edgedb-python-installation` +* :ref:`gel-python-installation` gel-python is installable via ``$ pip install gel``. Read the section for more information on how to install the library. -* :ref:`edgedb-python-examples` +* :ref:`gel-python-examples` High-level examples on how to use blocking and asyncio connections, as well as on how to work with transactions. -* :ref:`edgedb-python-asyncio-api-reference` +* :ref:`gel-python-asyncio-api-reference` Asynchronous API reference. -* :ref:`edgedb-python-blocking-api-reference` +* :ref:`gel-python-blocking-api-reference` Synchronous API reference. -* :ref:`edgedb-python-datatypes` +* :ref:`gel-python-datatypes` Gel Python types documentation. -* :ref:`edgedb-python-codegen` +* :ref:`gel-python-codegen` Python code generation command-line tool documentation. -* :ref:`edgedb-python-advanced` +* :ref:`gel-python-advanced` Advanced usages of the state and optional customization. diff --git a/docs/clients/python/installation.rst b/docs/clients/python/installation.rst index 3f16c29aee8..1da378193fb 100644 --- a/docs/clients/python/installation.rst +++ b/docs/clients/python/installation.rst @@ -1,4 +1,4 @@ -.. _edgedb-python-installation: +.. _gel-python-installation: Installation diff --git a/docs/clients/python/usage.rst b/docs/clients/python/usage.rst index 4619c380345..39377e5c12e 100644 --- a/docs/clients/python/usage.rst +++ b/docs/clients/python/usage.rst @@ -1,4 +1,4 @@ -.. _edgedb-python-examples: +.. _gel-python-examples: Basic Usage =========== @@ -63,17 +63,17 @@ Connect to Gel The examples above only work under an :ref:`Gel project `. You could also provide your own connection parameters, refer to the :ref:`Client Library Connection -` docs for details. +` docs for details. Type conversion --------------- gel-python automatically converts Gel types to the corresponding Python -types and vice versa. See :ref:`edgedb-python-datatypes` for details. +types and vice versa. See :ref:`gel-python-datatypes` for details. -.. _edgedb-python-connection-pool: +.. _gel-python-connection-pool: Client connection pools ----------------------- @@ -135,15 +135,15 @@ lazily as they are needed. If you want to explicitly connect to the database in ``init_app()``, use the ``ensure_connected()`` method on the client. For more information, see API documentation of :ref:`the blocking client -` and :ref:`the asynchronous client -`. +` and :ref:`the asynchronous client +`. Transactions ------------ The most robust way to create a -:ref:`transaction ` is the +:ref:`transaction ` is the ``transaction()`` method: * :py:meth:`AsyncIOClient.transaction() ` @@ -172,5 +172,5 @@ or, if using the async API: will be applied immediately. For more information, see API documentation of transactions for :ref:`the -blocking client ` and :ref:`the -asynchronous client `. +blocking client ` and :ref:`the +asynchronous client `. diff --git a/docs/edgeql/transactions.rst b/docs/edgeql/transactions.rst index 624e7b85cce..2063caaa463 100644 --- a/docs/edgeql/transactions.rst +++ b/docs/edgeql/transactions.rst @@ -99,7 +99,7 @@ Using the querybuilder: await query2.run(tx); }); -Full documentation at :ref:`Client Libraries > TypeScript/JS `; +Full documentation at :ref:`Client Libraries > TypeScript/JS `; Python ^^^^^^ @@ -115,7 +115,7 @@ Python filter .name = 'Customer2' set { bank_balance := .bank_balance +10 };""") -Full documentation at :ref:`Client Libraries > Python `; +Full documentation at :ref:`Client Libraries > Python `; Golang ^^^^^^ @@ -141,7 +141,7 @@ Golang log.Fatal(err) } -Full documentation at :ref:`Client Libraries > Go `. +Full documentation at :ref:`Client Libraries > Go `. Rust ^^^^ diff --git a/docs/guides/deployment/digitalocean.rst b/docs/guides/deployment/digitalocean.rst index 41df1ddf7e5..7a9588e8a9e 100644 --- a/docs/guides/deployment/digitalocean.rst +++ b/docs/guides/deployment/digitalocean.rst @@ -17,7 +17,7 @@ One-click Deploy Prerequisites ============= -* |gelcmd| CLI (`install `_) +* |gelcmd| CLI (`install `_) * DigitalOcean account Click the button below and follow the droplet creation workflow on @@ -36,7 +36,7 @@ something more secure. First, find your droplet's IP address on the it to an environment variable ``IP``. .. _DigitalOcean: https://cloud.digitalocean.com/droplets? -.. _here: edgedb-install_ +.. _here: gel-install_ .. code-block:: bash @@ -116,12 +116,12 @@ Deploy with Managed PostgreSQL Prerequisites ============= -* |gelcmd| CLI (`install `_) +* |gelcmd| CLI (`install `_) * DigitalOcean account * ``doctl`` CLI (`install `_) * ``jq`` (`install `_) -.. _edgedb-install: https://www.edgedb.com/install +.. _gel-install: https://www.edgedb.com/install .. _doclt-install: https://docs.digitalocean.com/reference/doctl/how-to/install .. _jq: https://stedolan.github.io/jq/ diff --git a/docs/guides/deployment/fly_io.rst b/docs/guides/deployment/fly_io.rst index e228d1f2a9f..765bd7194f8 100644 --- a/docs/guides/deployment/fly_io.rst +++ b/docs/guides/deployment/fly_io.rst @@ -164,7 +164,7 @@ to Postgres: ... ALTER ROLE -.. _ref_guide_deployment_fly_io_start_edgedb: +.. _ref_guide_deployment_fly_io_start_gel: Start Gel ========= @@ -296,7 +296,7 @@ something like this: timeout = "2s" In the same directory, :ref:`redeploy the Gel app -`. This makes the Gel port +`. This makes the Gel port available to the outside world. You can now access the instance from any host via the following public DSN: :geluri:`admin:$PASSWORD@$EDB_APP.fly.dev`. diff --git a/docs/guides/deployment/heroku.rst b/docs/guides/deployment/heroku.rst index c429768ef8a..29ebbd99154 100644 --- a/docs/guides/deployment/heroku.rst +++ b/docs/guides/deployment/heroku.rst @@ -42,7 +42,7 @@ First copy the code, initialize a new git repo, and create a new heroku app. $ heroku apps:create --buildpack heroku/nodejs $ edgedb project init --non-interactive -If you are using the :ref:`JS query builder for Gel ` then +If you are using the :ref:`JS query builder for Gel ` then you will need to check the ``dbschema/edgeql-js`` directory in to your git repo after running ``yarn edgeql-js``. The ``edgeql-js`` command cannot be run during the build step on Heroku because it needs access to a running diff --git a/docs/guides/tutorials/chatgpt_bot.rst b/docs/guides/tutorials/chatgpt_bot.rst index bae38257979..b489e7e4b44 100644 --- a/docs/guides/tutorials/chatgpt_bot.rst +++ b/docs/guides/tutorials/chatgpt_bot.rst @@ -604,7 +604,7 @@ libraries that will help us. The ``@edgedb/generate`` package provides a set of code generation tools that are useful when developing an Gel-backed applications with TypeScript/JavaScript. We're going to write queries using our -:ref:`query builder `, but before we can, we +:ref:`query builder `, but before we can, we need to run the query builder generator. .. code-block:: bash diff --git a/docs/intro/clients.rst b/docs/intro/clients.rst index ed81ed37f18..eefc0555fcf 100644 --- a/docs/intro/clients.rst +++ b/docs/intro/clients.rst @@ -34,9 +34,9 @@ Available libraries To execute queries from your application code, use one of Gel's *client libraries* for the following languages. -- :ref:`JavaScript/TypeScript ` -- :ref:`Go ` -- :ref:`Python ` +- :ref:`JavaScript/TypeScript ` +- :ref:`Go ` +- :ref:`Python ` .. XXX: link to third-party doc websites .. - :ref:`Rust ` diff --git a/docs/intro/edgeql.rst b/docs/intro/edgeql.rst index 33e48ef62d7..3140651e011 100644 --- a/docs/intro/edgeql.rst +++ b/docs/intro/edgeql.rst @@ -12,7 +12,7 @@ intended as a rapid-fire overview so you can hit the ground running with .. note:: The examples below also demonstrate how to express the query with the - :ref:`TypeScript client's ` query builder, which lets you + :ref:`TypeScript client's ` query builder, which lets you express arbitrary EdgeQL queries in a code-first, typesafe way. diff --git a/docs/intro/quickstart.rst b/docs/intro/quickstart.rst index 0ae3b98a25b..7273b4a8ab5 100644 --- a/docs/intro/quickstart.rst +++ b/docs/intro/quickstart.rst @@ -508,9 +508,9 @@ will look something like this: likely be using one of Gel's *client libraries* to execute queries. Gel provides official libraries for many langauges: -- :ref:`JavaScript/TypeScript ` -- :ref:`Go ` -- :ref:`Python ` +- :ref:`JavaScript/TypeScript ` +- :ref:`Go ` +- :ref:`Python ` .. XXX: link to third-party doc websites .. - :ref:`Rust ` @@ -545,9 +545,9 @@ and used a client library. - To start building an application using the language of your choice, check out our client libraries: - - :ref:`JavaScript/TypeScript ` - - :ref:`Go ` - - :ref:`Python ` + - :ref:`JavaScript/TypeScript ` + - :ref:`Go ` + - :ref:`Python ` .. XXX: link to third-party doc websites .. - :ref:`Rust `