Skip to content

Commit

Permalink
More refs
Browse files Browse the repository at this point in the history
  • Loading branch information
1st1 committed Feb 15, 2025
1 parent bde0104 commit 98641e0
Show file tree
Hide file tree
Showing 43 changed files with 145 additions and 145 deletions.
2 changes: 1 addition & 1 deletion docs/changelog/1_0_a2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ and it is ready for use:
main();
The documentation can be found :ref:`here <edgedb-js-intro>`.
The documentation can be found :ref:`here <gel-js-intro>`.


Standard Library
Expand Down
2 changes: 1 addition & 1 deletion docs/changelog/1_0_a5.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ CLI
Bindings
========

* Add transaction :ref:`API <edgedb-js-api-transaction>` to JS binding
* Add transaction :ref:`API <gel-js-api-transaction>` to JS binding
(`#61 <https://github.com/edgedb/edgedb-js/pull/61>`_). Here's an
example of using transactions:

Expand Down
6 changes: 3 additions & 3 deletions docs/changelog/2_x.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,11 +93,11 @@ upgrade.

.. list-table::

* - :ref:`TypeScript/JS <edgedb-js-intro>`
* - :ref:`TypeScript/JS <gel-js-intro>`
- ``[email protected]``
* - :ref:`Python <edgedb-python-intro>`
* - :ref:`Python <gel-python-intro>`
- ``[email protected]``
* - :ref:`Golang <edgedb-go-intro>`
* - :ref:`Golang <gel-go-intro>`
- ``[email protected]``
* - `Rust <https://github.com/edgedb/edgedb-rust>`_
- ``[email protected]``
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/edgedb.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _ref_cli_edgedb:
.. _ref_cli_gel:

===
gel
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/edgedb_analyze.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ gel analyze
.. note::

Performance analysis is also available in our :ref:`CLI REPL
<ref_cli_edgedb>` and the UI's REPL and query builder (both accessible by
<ref_cli_gel>` 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``.

Expand Down
6 changes: 3 additions & 3 deletions docs/clients/connection.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _edgedb_client_connection:
.. _gel_client_connection:

==========
Connection
Expand All @@ -22,7 +22,7 @@ library.
- Set the ``EDGEDB_INSTANCE`` environment variable to a :ref:`name
<ref_reference_connection_instance_name>` of a local instance, remote linked
instance, or an |Gel| Cloud instance. (:ref:`More info on |Gel| Cloud
connection details below. <edgedb_client_connection_cloud>`) You can create
connection details below. <gel_client_connection_cloud>`) You can create
new instances manually with the :ref:`gel instance create
<ref_cli_gel_instance_create>` command.

Expand All @@ -49,7 +49,7 @@ supports several other options for advanced use cases. For a complete reference
on connection configuration, see :ref:`Reference > Connection Parameters
<ref_reference_connection>`.

.. _edgedb_client_connection_cloud:
.. _gel_client_connection_cloud:

Gel Cloud
=========
Expand Down
2 changes: 1 addition & 1 deletion docs/clients/go/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _edgedb-go-intro:
.. _gel-go-intro:

=============
Gel Go Driver
Expand Down
2 changes: 1 addition & 1 deletion docs/clients/graphql/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Then create a new migration and apply it.
$ gel migration create
$ gel migrate
Refer to the :ref:`connection docs <edgedb_client_connection>` for various
Refer to the :ref:`connection docs <gel_client_connection>` for various
methods of running these commands against remotely-hosted instances.

Connection
Expand Down
2 changes: 1 addition & 1 deletion docs/clients/js/delete.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _edgedb-js-delete:
.. _gel-js-delete:

Delete
------
Expand Down
10 changes: 5 additions & 5 deletions docs/clients/js/driver.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _edgedb-js-driver:
.. _gel-js-driver:


Client
Expand All @@ -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
----------------
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -377,7 +377,7 @@ a query, use the ``.ensureConnected()`` method.
await client.ensureConnected();
}
.. _edgedb-js-api-transaction:
.. _gel-js-api-transaction:

Transactions
------------
Expand Down Expand Up @@ -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 <edgedb-js-qb>`. If you're using plain
over to the :ref:`Query Builder docs <gel-js-qb>`. 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.
16 changes: 8 additions & 8 deletions docs/clients/js/for.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _edgedb-js-for:
.. _gel-js-for:


For Loops
Expand All @@ -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
------------
Expand Down Expand Up @@ -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
----------------------------------
Expand Down Expand Up @@ -158,7 +158,7 @@ down.
}
);
.. _edgedb-js-for-bulk-inserts-conflicts-params:
.. _gel-js-for-bulk-inserts-conflicts-params:

Structured params
~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -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
~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -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
^^^^^^^^^^^^
Expand Down Expand Up @@ -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 <edgedb-js-qb-transaction>`, but a single query is already atomic
transaction <gel-js-qb-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
Expand Down
8 changes: 4 additions & 4 deletions docs/clients/js/funcops.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _edgedb-js-funcops:
.. _gel-js-funcops:

Functions and Operators
-----------------------
Expand All @@ -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
^^^^^^^^^^^^^^^^
Expand All @@ -45,7 +45,7 @@ Prefix operators operate on a single argument: ``OPERATOR <arg>``.
* - ``"exists"`` ``"distinct"`` ``"not"``


.. _edgedb-js-funcops-infix:
.. _gel-js-funcops-infix:

Infix operators
^^^^^^^^^^^^^^^
Expand All @@ -65,7 +65,7 @@ Infix operators operate on two arguments: ``<arg> OPERATOR <arg>``.
``"ilike"`` ``"not like"`` ``"not ilike"``


.. _edgedb-js-funcops-ternary:
.. _gel-js-funcops-ternary:

Ternary operators
^^^^^^^^^^^^^^^^^
Expand Down
14 changes: 7 additions & 7 deletions docs/clients/js/generation.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _edgedb-js-generators:
.. _gel-js-generators:

Generators
==========
Expand All @@ -10,7 +10,7 @@ TypeScript/JavaScript.
To get started with generators, first initialize an :ref:`Gel project
<ref_guide_using_projects>` 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 <edgedb-js-installation>` page for details on installing.
the :ref:`Overview <gel-js-installation>` page for details on installing.

.. note::

Expand Down Expand Up @@ -57,18 +57,18 @@ The value of ``<generator>`` 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 <edgedb-js-qb>`
- :ref:`docs <gel-js-qb>`

* - ``queries``
- Scans your project for ``*.edgeql`` files and generates functions that
allow you to execute these queries in a typesafe way.
- :ref:`docs <edgedb-js-queries>`
- :ref:`docs <gel-js-queries>`

* - ``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 <edgedb-js-interfaces>`
- :ref:`docs <gel-js-interfaces>`

Connection
^^^^^^^^^^
Expand All @@ -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 <edgedb_client_connection>` for guidance.
:ref:`Client Libraries > Connection <gel_client_connection>` for guidance.

.. _edgedb_qb_target:
.. _gel_qb_target:

Targets
^^^^^^^
Expand Down
2 changes: 1 addition & 1 deletion docs/clients/js/group.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _edgedb-js-group:
.. _gel-js-group:

Group
=====
Expand Down
14 changes: 7 additions & 7 deletions docs/clients/js/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _edgedb-js-intro:
.. _gel-js-intro:

========================
Gel TypeScript/JS Client
Expand Down Expand Up @@ -27,7 +27,7 @@ Gel TypeScript/JS Client
group
reference

.. _edgedb-js-installation:
.. _gel-js-installation:


Installation
Expand Down Expand Up @@ -89,7 +89,7 @@ generators from npm using your package manager of choice.
}
.. _edgedb-js-quickstart:
.. _gel-js-quickstart:

Quickstart
==========
Expand Down Expand Up @@ -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 <edgedb-js-interfaces>` to tell TypeScript what the type of our result
generator <gel-js-interfaces>` to tell TypeScript what the type of our result
is.

First we run the generator:
Expand Down Expand Up @@ -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 <edgedb-js-queries>` scans your project for
does! The :ref:`queries generator <gel-js-queries>` 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``.
Expand Down Expand Up @@ -396,8 +396,8 @@ in TypeScript, getting editor completion, type checking, and type inferrence:
What's next
===========

We recommend reading the :ref:`client docs <edgedb-js-driver>` first and getting
We recommend reading the :ref:`client docs <gel-js-driver>` 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 <edgedb-js-qb>` documentation
preferences, look through the :ref:`query builder <gel-js-qb>` documentation
and use the other pages as a reference for writing code-first Gel queries.
6 changes: 3 additions & 3 deletions docs/clients/js/insert.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _edgedb-js-insert:
.. _gel-js-insert:

Insert
------
Expand Down Expand Up @@ -158,5 +158,5 @@ properties in a tuple.
Bulk inserts
^^^^^^^^^^^^
You can use a :ref:`for loop <edgedb-js-for>` to perform :ref:`bulk inserts
<edgedb-js-for-bulk-inserts>`.
You can use a :ref:`for loop <gel-js-for>` to perform :ref:`bulk inserts
<gel-js-for-bulk-inserts>`.
2 changes: 1 addition & 1 deletion docs/clients/js/interfaces.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _edgedb-js-interfaces:
.. _gel-js-interfaces:

====================
Interfaces Generator
Expand Down
4 changes: 2 additions & 2 deletions docs/clients/js/literals.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _edgedb-js-literals:
.. _gel-js-literals:


Literals
Expand Down Expand Up @@ -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 <edgedb-js-datatypes>` docs.
on the :ref:`Client API <gel-js-datatypes>` docs.

.. list-table::

Expand Down
4 changes: 2 additions & 2 deletions docs/clients/js/objects.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _edgedb-js-objects:
.. _gel-js-objects:


Objects and Paths
Expand Down Expand Up @@ -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
^^^^^^^^^^^^^^^^^^
Expand Down
Loading

0 comments on commit 98641e0

Please sign in to comment.