Skip to content

Commit

Permalink
Update links in docs and comments. (#111)
Browse files Browse the repository at this point in the history
  • Loading branch information
dnwpark authored Feb 22, 2025
1 parent 7561dd3 commit fc91700
Show file tree
Hide file tree
Showing 21 changed files with 45 additions and 45 deletions.
2 changes: 1 addition & 1 deletion .gitmodules
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[submodule "tests/Gel.Tests.Unit/shared-client-testcases"]
path = tests/Gel.Tests.Unit/shared-client-testcases
url = https://github.com/edgedb/shared-client-testcases.git
url = https://github.com/geldata/shared-client-testcases.git
4 changes: 2 additions & 2 deletions Gel.Net.targets
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
<LangVersion>latest</LangVersion>
<Authors>Gel.Net Contributors</Authors>
<PackageTags>edgedb;gel;db;database</PackageTags>
<PackageProjectUrl>https://github.com/edgedb/edgedb-net</PackageProjectUrl>
<PackageProjectUrl>https://github.com/geldata/gel-net</PackageProjectUrl>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<PackageIcon>PackageLogo.png</PackageIcon>
<RepositoryType>git</RepositoryType>
<RepositoryUrl>git://github.com/edgedb/edgedb-net</RepositoryUrl>
<RepositoryUrl>git://github.com/geldata/gel-net</RepositoryUrl>
</PropertyGroup>
<PropertyGroup Condition=" '$(BuildNumber)' == '' ">
<VersionSuffix Condition=" '$(VersionSuffix)' != ''">$(VersionSuffix)-dev</VersionSuffix>
Expand Down
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![Gel.Net](https://raw.githubusercontent.com/edgedb/edgedb-net/dev/branding/Banner.png)
![Gel.Net](https://raw.githubusercontent.com/geldata/gel-net/dev/branding/Banner.png)

<p align="center">
<a href="https://www.nuget.org/packages/Gel.Net.Driver/">
Expand All @@ -7,21 +7,21 @@
<a href="https://www.nuget.org/packages/Gel.Net.Driver/">
<img src="https://img.shields.io/nuget/vpre/Gel.Net.Driver.svg?maxAge=2592000?style=plastic" alt="NuGet">
</a>
<a href="https://github.com/edgedb/edgedb-net/actions/workflows/tests.yml">
<img src="https://github.com/edgedb/edgedb-net/actions/workflows/tests.yml/badge.svg?branch=dev" alt="Tests">
<a href="https://github.com/geldata/gel-net/actions/workflows/tests.yml">
<img src="https://github.com/geldata/gel-net/actions/workflows/tests.yml/badge.svg?branch=dev" alt="Tests">
</a>
<a href="https://discord.gg/tM4EpAaeSq">
<img src="https://discord.com/api/guilds/841451783728529451/widget.png" alt="Discord">
</a>

<p align="center">
Gel.Net is the official .NET driver for the <a href="https://edgedb.com">Gel</a> database.
Gel.Net is the official .NET driver for the <a href="https://geldata.com">Gel</a> database.
</p>
</p>

## Documentation

Documentation for the dotnet driver can be found [here](https://www.edgedb.com/docs/clients/dotnet).
Documentation for the dotnet driver can be found [here](https://www.geldata.com/docs/clients/dotnet).

## Installation

Expand All @@ -38,7 +38,7 @@ $ dotnet add package Gel.Net.Driver
### Creating a client

Clients are what allow your code to talk and interface with Gel. The
[`GelClientPool`](https://www.edgedb.com/docs/clients/dotnet/api#EdgeDB.GelClientPool)
[`GelClientPool`](https://www.geldata.com/docs/clients/dotnet/api#Gel.GelClientPool)
class contains a pool of connections and numerous abstractions for executing
queries with ease:

Expand All @@ -51,10 +51,10 @@ var client = new GelClientPool();
### Client configuration

`GelClientPool` will automatically determine how to connect to your Gel
instance by resolving [Gel Projects](https://www.edgedb.com/docs/intro/projects).
instance by resolving [Gel Projects](https://www.geldata.com/docs/intro/projects).
For specifying custom connection arguments, considering checking out the
[`GelConnection`](https://www.edgedb.com/docs/clients/dotnet/connection_parameters#GelConnection)
class. Here's an example of using the [`.Create()`](https://www.edgedb.com/docs/clients/dotnet/connection_parameters#GelConnection.Create-Options?)
[`GelConnection`](https://www.geldata.com/docs/clients/dotnet/connection_parameters#GelConnection)
class. Here's an example of using the [`.Create()`](https://www.geldata.com/docs/clients/dotnet/connection_parameters#GelConnection.Create-Options?)
method:

```cs
Expand All @@ -74,7 +74,7 @@ operations are performed asynchronously.

Queries are executed through the `GelClientPool` by using different helper
methods. Your choice of method is dependent on the kind of query you're making,
better known as [cardinality](https://www.edgedb.com/docs/clients/dotnet/index#cardinality-and-return-types).
better known as [cardinality](https://www.geldata.com/docs/clients/dotnet/index#cardinality-and-return-types).

Query helper methods will expect a generic `T` type which is the [.NET version of an Gel type](https://www.edgedb.com/docs/clients/dotnet/datatypes#datatypes):

Expand Down
12 changes: 6 additions & 6 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -658,7 +658,7 @@ API Documentation

.. dn:method:: WithGlobals(IDictionary<string,object> globals): GelClientPool
Creates a new client with the specified `Globals <https://www.edgedb.com/docs/datamodel/globals#globals>`_.
Creates a new client with the specified `Globals <https://www.geldata.com/docs/datamodel/globals#globals>`_.

.. note::

Expand Down Expand Up @@ -747,23 +747,23 @@ API Documentation

.. note::

This property defaults to ``edgedb``. It is mutually exclusive with ``Gel.GelConnection.Branch``.
This property defaults to ``"edgedb"``. It is mutually exclusive with ``Gel.GelConnection.Branch``.


:property string Branch:
Gets the branch name to use when connecting.

.. note::

This property defaults to ``__default__``. It is mutually exclusive with ``Gel.GelConnection.Database``
This property defaults to ``"__default__"``. It is mutually exclusive with ``Gel.GelConnection.Database``


:property string Username:
Gets the username used to connect to the database.

.. note::

This property defaults to edgedb
This property defaults to ``"edgedb"``


:property string Password:
Expand Down Expand Up @@ -824,7 +824,7 @@ API Documentation
If any primary ``T:Gel.GelConnection.Options`` are present, then all environment variables
are ignored.

See the `documentation <https://www.edgedb.com/docs/reference/connection>`_ for more information.
See the `documentation <https://www.geldata.com/docs/reference/connection>`_ for more information.

:param Options options:
Options used to build the :dn:class:`Gel.GelConnection`.
Expand Down Expand Up @@ -2095,7 +2095,7 @@ API Documentation

.. dn:struct:: Range<T>
Represents the `Range <https://www.edgedb.com/docs/stdlib/range>`_ type in Gel.
Represents the `Range <https://www.geldata.com/docs/stdlib/range>`_ type in Gel.

:param T:
The inner type of the range.
Expand Down
8 changes: 4 additions & 4 deletions docs/connection_parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ a ``GelConnection`` is to use the static helper method ``Create``
Gets the username used to connect to the database.

.. note::
This property defaults to edgedb
This property defaults to ``edgedb``

:property string Password:
Gets the password to connect to the database.
Expand Down Expand Up @@ -88,7 +88,7 @@ a ``GelConnection`` is to use the static helper method ``Create``
If any primary ``T:Gel.GelConnection.Options`` are present, then all environment variables
are ignored.

See the `documentation <https://www.edgedb.com/docs/reference/connection>`_ for more information.
See the `documentation <https://www.geldata.com/docs/reference/connection>`_ for more information.

:param Options options:
Options used to build the :dn:class:`Gel.GelConnection`.
Expand All @@ -100,6 +100,6 @@ a ``GelConnection`` is to use the static helper method ``Create``
An error occured while parsing or configuring the :dn:class:`Gel.GelConnection`.


.. _Priority Levels: https://www.edgedb.com/docs/reference/connection#ref-reference-connection-priority
.. _gel DSN: https://www.edgedb.com/docs/reference/dsn
.. _Priority Levels: https://www.geldata.com/docs/reference/connection#ref-reference-connection-priority
.. _gel DSN: https://www.geldata.com/docs/reference/dsn

2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Quickstart

To start, you will need to setup an Gel project and have an instance
created. For more information regarding how to do this, we recommend going
through the `Quickstart guide <https://www.edgedb.com/docs/intro/quickstart>`_.
through the `Quickstart guide <https://www.geldata.com/docs/intro/quickstart>`_.

After you have an instance running, you may now create an ``GelClientPool``:

Expand Down
8 changes: 4 additions & 4 deletions examples/Gel.Examples.ExampleTODOApi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Then verify that the CLI is installed and available with the `gel --version` com
a `Command not found` error, you may need to open a new terminal window before the `gel` command is available.

Once the CLI is installed, we can initialize a project for our TODO api. You can read more
about [Gel projects here.](https://www.edgedb.com/docs/guides/projects)
about [Gel projects here.](https://www.geldata.com/docs/guides/projects)

```console
$ gel project init
Expand Down Expand Up @@ -106,7 +106,7 @@ module default {

Our todo structure will consist of four feilds: `title`, `description`, `date_created`, and `state`. Our `state` field
will be the state of the todo ex: `Not Started`, `In Progress`, `Completed`, for this we will have to define our own
enum type. You can read more about [enums here.](https://www.edgedb.com/docs/datamodel/primitives#enums).
enum type. You can read more about [enums here.](https://www.geldata.com/docs/datamodel/primitives#enums).

```diff
module default {
Expand Down Expand Up @@ -399,7 +399,7 @@ namespace Gel.Examples.ExampleTODOApi.Controllers

Our new route will validate the todo we're passing in and if it's valid, we'll insert it into the database. One thing to
note here is we're using the `Dictionary<string, object?>` to pass in our parameters. This is to prevent any query
injection attacks. You can learn more about [EdgeQL parameters here.](https://www.edgedb.com/docs/edgeql/parameters).
injection attacks. You can learn more about [EdgeQL parameters here.](https://www.geldata.com/docs/edgeql/parameters).

### Testing the POST route

Expand Down Expand Up @@ -610,4 +610,4 @@ As we can see our state was updated successfully.

This tutorial has covered the basics of how to use the Gel client to query, update and delete data. Feel free to
expirement with the source
code [here](https://github.com/edgedb/edgedb-net/tree/dev/examples/Gel.Examples.ExampleTODOApi).
code [here](https://github.com/geldata/gel-net/tree/dev/examples/Gel.Examples.ExampleTODOApi).
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ namespace Gel.Binary.Protocol.V1._0.Packets;

/// <summary>
/// Represents the
/// <see href="https://www.edgedb.com/docs/reference/protocol/messages#authenticationok">AuthenticationOK</see>,
/// <see href="https://www.geldata.com/docs/reference/protocol/messages#authenticationok">AuthenticationOK</see>,
/// <see href="https://www.edgedb.com/docs/reference/protocol/messages#authenticationsasl">AuthenticationSASL</see>,
/// <see href="https://www.edgedb.com/docs/reference/protocol/messages#authenticationsaslcontinue">AuthenticationSASLContinue</see>
/// ,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ namespace Gel.Binary.Protocol.V1._0.Packets;

/// <summary>
/// Represents the
/// <see href="https://www.edgedb.com/docs/reference/protocol/messages#commanddatadescription">Command Data Description</see>
/// <see href="https://www.geldata.com/docs/reference/protocol/messages#commanddatadescription">Command Data Description</see>
/// packet.
/// </summary>
internal readonly struct CommandDataDescription : IReceiveable
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
namespace Gel.Binary.Protocol.V1._0.Packets;

/// <summary>
/// Represents the <see href="https://www.edgedb.com/docs/reference/protocol/messages#data">Data</see> packet
/// Represents the <see href="https://www.geldata.com/docs/reference/protocol/messages#data">Data</see> packet
/// </summary>
internal readonly struct Data : IReceiveable
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
namespace Gel.Binary.Protocol.V1._0.Packets;

/// <summary>
/// Represents the <see href="https://www.edgedb.com/docs/reference/protocol/messages#dump-header">Dump Header</see>
/// Represents the <see href="https://www.geldata.com/docs/reference/protocol/messages#dump-header">Dump Header</see>
/// packet.
/// </summary>
internal readonly struct DumpHeader : IReceiveable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ namespace Gel.Binary.Protocol.V1._0.Packets;

/// <summary>
/// Represents the
/// <see href="https://www.edgedb.com/docs/reference/protocol/messages#readyforcommand">Ready for Command</see> packet.
/// <see href="https://www.geldata.com/docs/reference/protocol/messages#readyforcommand">Ready for Command</see> packet.
/// </summary>
internal readonly struct ReadyForCommand : IReceiveable
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
namespace Gel.Binary.Protocol.V1._0.Packets;

/// <summary>
/// Represents the <see href="https://www.edgedb.com/docs/reference/protocol/messages#restoreready">Restore Ready</see>
/// Represents the <see href="https://www.geldata.com/docs/reference/protocol/messages#restoreready">Restore Ready</see>
/// packet.
/// </summary>
internal readonly struct RestoreReady : IReceiveable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ namespace Gel.Binary.Protocol.V1._0.Packets;

/// <summary>
/// Represents the
/// <see href="https://www.edgedb.com/docs/reference/protocol/messages#statedatadescription">State Data Description</see>
/// <see href="https://www.geldata.com/docs/reference/protocol/messages#statedatadescription">State Data Description</see>
/// packet.
/// </summary>
internal readonly struct StateDataDescription : IReceiveable
Expand Down
2 changes: 1 addition & 1 deletion src/Gel.Net.Driver/Binary/Protocol/V1.0/Sendables/Parse.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
namespace Gel.Binary.Protocol.V1._0.Packets;

/// <summary>
/// https://www.edgedb.com/docs/reference/protocol/messages#prepare
/// https://www.geldata.com/docs/reference/protocol/messages#prepare
/// </summary>
internal sealed class Parse : Sendable
{
Expand Down
2 changes: 1 addition & 1 deletion src/Gel.Net.Driver/Extensions/GelClientExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ internal static async Task TransactionInternalAsync(ITransactibleClient client,
await transaction.RollbackAsync().ConfigureAwait(false);
}
catch (Exception rollbackErr) when
(rollbackErr is not GelException) // see https://github.com/edgedb/edgedb-js/blob/f170b5f53eab605454704e869e083c2afc693ada/src/client.ts#L142
(rollbackErr is not GelException) // see https://github.com/geldata/gel-js/blob/f170b5f53eab605454704e869e083c2afc693ada/src/client.ts#L142
{
throw;
}
Expand Down
2 changes: 1 addition & 1 deletion src/Gel.Net.Driver/GelClientPool.cs
Original file line number Diff line number Diff line change
Expand Up @@ -507,7 +507,7 @@ public GelClientPool WithConfig(Config config)

/// <summary>
/// Creates a new client with the specified
/// <see href="https://www.edgedb.com/docs/datamodel/globals#globals">Globals</see>.
/// <see href="https://www.geldata.com/docs/datamodel/globals#globals">Globals</see>.
/// </summary>
/// <remarks>
/// The created client is a 'sub' client of this one, the child client
Expand Down
8 changes: 4 additions & 4 deletions src/Gel.Net.Driver/GelConnection.cs
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ public int Port
/// Gets the database name to use when connecting.
/// </summary>
/// <remarks>
/// This property defaults to <c>edgedb</c>. It is mutually exclusive with <see cref="Branch"/>.
/// This property defaults to <c>"edgedb"</c>. It is mutually exclusive with <see cref="Branch"/>.
/// </remarks>
public string? Database
{
Expand All @@ -128,7 +128,7 @@ public string? Database
/// Gets the branch name to use when connecting.
/// </summary>
/// <remarks>
/// This property defaults to <c>__default__</c>. It is mutually exclusive with <see cref="Database"/>
/// This property defaults to <c>"__default__"</c>. It is mutually exclusive with <see cref="Database"/>
/// </remarks>
public string? Branch
{
Expand All @@ -141,7 +141,7 @@ public string? Branch
/// Gets the username used to connect to the database.
/// </summary>
/// <remarks>
/// This property defaults to edgedb
/// This property defaults to <c>"edgedb"</c>
/// </remarks>
public string Username
{
Expand Down Expand Up @@ -271,7 +271,7 @@ Instance is null
///
/// If any primary <see cref="Options"/> are present, then all environment variables are ignored.
///
/// See the <see href="https://www.edgedb.com/docs/reference/connection">documentation</see>
/// See the <see href="https://www.geldata.com/docs/reference/connection">documentation</see>
/// for more information.
/// </summary>
/// <param name="options">Options used to build the <see cref="GelConnection" />.</param>
Expand Down
2 changes: 1 addition & 1 deletion src/Gel.Net.Driver/Models/DataTypes/Range.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
namespace Gel.DataTypes;

/// <summary>
/// Represents the <see href="https://www.edgedb.com/docs/stdlib/range">Range</see> type in Gel.
/// Represents the <see href="https://www.geldata.com/docs/stdlib/range">Range</see> type in Gel.
/// </summary>
/// <typeparam name="T">The inner type of the range.</typeparam>
public readonly struct Range<T>
Expand Down
2 changes: 1 addition & 1 deletion src/Gel.Net.Driver/Models/IOFormat.cs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ public enum IOFormat : byte
{
/// <summary>
/// The format will be encoded as binary following the
/// <see href="https://www.edgedb.com/docs/reference/protocol/dataformats#data-wire-formats">Data Wire Formats</see>
/// <see href="https://www.geldata.com/docs/reference/protocol/dataformats#data-wire-formats">Data Wire Formats</see>
/// protocol.
/// </summary>
Binary = 0x62,
Expand Down
2 changes: 1 addition & 1 deletion tools/Gel.DotnetTool/dbschema/default.esdl
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ module default {
type Simple extending HasName, HasAge {}

# Unicode handling
# https://github.com/edgedb/edgedb/blob/master/tests/schemas/dump02_default.esdl
# https://github.com/geldata/gel/blob/master/tests/schemas/dump02_default.esdl

abstract annotation `🍿`;

Expand Down

0 comments on commit fc91700

Please sign in to comment.