Update edgedb name to gel in docs and build configs. (#52)

dnwpark · web-flow · commit 959178423371 · 2025-02-20T12:24:00.000-05:00
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
-![EdgeDB Java](./branding/banner.png)
+![Gel Java](./branding/banner.png)
 
 <div align="center">
-  <h1>☕ The official Java/JVM client library for EdgeDB ☕</h1>
+  <h1>☕ The official Java/JVM client library for Gel ☕</h1>
 
   <a href="https://github.com.gel/edgedb-java/actions" rel="nofollow">
     <img src="https://github.com.gel/edgedb-java/actions/workflows/gradle.yml/badge.svg?event=push&branch=master" alt="Build status">
@@ -42,7 +42,7 @@ libraryDependencies ++= Seq(
 
 ## Usage
 
-The `GelClientPool` class contains all the methods necessary to interact with the EdgeDB database.
+The `GelClientPool` class contains all the methods necessary to interact with the Gel database.
 
 ```java
 import com.gel.driver.GelClientPool;
diff --git a/build.gradle b/build.gradle
@@ -9,7 +9,7 @@ ext {
     github_org = 'edgedb'
     project_name = 'edgedb-java'
     artifact_group = 'com.gel'
-    project_description = 'Java binding for the EdgeDB database'
+    project_description = 'Java binding for Gel'
     project_url = "https://edgedb.com"
     project_jdk = '11'
     jdk = JavaVersion.current().majorVersion
diff --git a/dbschema/futures.esdl b/dbschema/futures.esdl
@@ -1,4 +1,4 @@
 # Disable the application of access policies within access policies
-# themselves. This behavior will become the default in EdgeDB 3.0.
+# themselves. This behavior will become the default in Gel 3.0.
 # See: https://www.edgedb.com/docs/reference/ddl/access_policies#nonrecursive
 using future nonrecursive_access_policies;
diff --git a/docs/conf.py b/docs/conf.py
@@ -17,9 +17,9 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'edgedb'
-copyright = '2019-present MagicStack Inc. and the EdgeDB authors.'
-author = 'MagicStack Inc. and the EdgeDB authors'
+project = 'gel'
+copyright = '2019-present MagicStack Inc. and the Gel authors.'
+author = 'MagicStack Inc. and the Gel authors'
 
 
 # The full version, including alpha/beta/rc tags
diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -1,4 +1,4 @@
-.. _edgedb-java-configuration:
+.. _gel-java-configuration:
 
 =============
 Configuration
@@ -30,7 +30,7 @@ These are the following methods exposed on the configuration builder:
 +------------------------------+-------------------------+---------------------------------------------------------------------------------------------+
 | ``withConnectionTimeout``    | ``long``, ``TimeUnit``  | The amount of time to wait for a connection to be established.                              |
 +------------------------------+-------------------------+---------------------------------------------------------------------------------------------+
-| ``withMessageTimeout``       | ``long, TimeUnit``      | The amount of time to wait for an expected response from EdgeDB.                            |
+| ``withMessageTimeout``       | ``long, TimeUnit``      | The amount of time to wait for an expected response from Gel.                               |
 +------------------------------+-------------------------+---------------------------------------------------------------------------------------------+
 | ``withExplicitObjectIds``    | ``boolean``             | Whether or not the ``id`` property of objects need to be explicitly included in shapes.     |
 +------------------------------+-------------------------+---------------------------------------------------------------------------------------------+
diff --git a/docs/connecting.rst b/docs/connecting.rst
@@ -1,4 +1,4 @@
-.. _edgedb_java_connecting:
+.. _gel_java_connecting:
 
 =====================
 Connection Parameters
@@ -56,18 +56,18 @@ This method parses a :ref:`DSN <ref_dsn>` string into an ``GelConnection``.
 .. code-block:: java
 
     var connection = GelConnection
-        .fromDSN("edgedb://user:pass@host:port/db");
+        .fromDSN("gel://user:pass@host:port/db");
 
 fromProjectFile
 ^^^^^^^^^^^^^^^
 
-This method resolves connection arguments from an ``edgedb.toml`` 
+This method resolves connection arguments from a ``gel.toml`` 
 :ref:`project file <ref_intro_projects>`.
 
 .. code-block:: java
 
     var connection = GelConnection
-        .fromProjectFile("~/myproject/edgedb.toml");
+        .fromProjectFile("~/myproject/gel.toml");
 
 fromInstanceName
 ^^^^^^^^^^^^^^^^
@@ -83,7 +83,7 @@ resolveEdgeDBTOML
 ^^^^^^^^^^^^^^^^^
 
 This method is the default behaviour, it scans the current directory for
-a ``edgedb.toml`` project file, if none is found, the parent directory is 
+a ``gel.toml`` project file, if none is found, the parent directory is 
 scanned recursivly until a project file is found; if none is found, a 
 ``FileNotFoundException`` is raised.
 
diff --git a/docs/datamodeling.rst b/docs/datamodeling.rst
@@ -1,4 +1,4 @@
-.. _edgedb_java_datamodeling:
+.. _gel_java_datamodeling:
 
 =============
 Data modeling
@@ -10,7 +10,7 @@ Basic representation
 --------------------
 
 You can simply create a class that matches the schema types' properties
-by following the :ref:`scalar type map <edgedb_java_datatypes>`.
+by following the :ref:`scalar type map <gel_java_datatypes>`.
 
 .. tabs::
 
diff --git a/docs/datatypes.rst b/docs/datatypes.rst
@@ -1,13 +1,13 @@
-.. _edgedb_java_datatypes:
+.. _gel_java_datatypes:
 
 =========
 Datatypes
 =========
 
-The Java binding maps the following EdgeDB types to corresponding JVM types:
+The Java binding maps the following Gel types to corresponding JVM types:
 
 +------------------------------------+---------------------------------------------------------+
-| EdgeDB Type                        | JVM Type                                                |
+| Gel Type                           | JVM Type                                                |
 +====================================+=========================================================+
 | ``Set``                            | ``Collection<T>``                                       |
 +------------------------------------+---------------------------------------------------------+
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,8 +1,8 @@
-.. _edgedb-java-intro:
+.. _gel-java-intro:
 
-==============================
-Java client library for EdgeDB
-==============================
+===========================
+Java client library for Gel
+===========================
 
 .. toctree:: 
     :maxdepth: 3
@@ -15,12 +15,12 @@ Java client library for EdgeDB
     transactions
 
 
-This is the official EdgeDB Java client, available to other JVM languages as well.
+This is the official Gel Java client, available to other JVM languages as well.
 
 Quickstart
 ----------
 
-To get started, you will need to setup an EdgeDB project and have an instance
+To get started, 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>`_.
 
@@ -43,7 +43,7 @@ project.
         implementation 'com.gel:driver'
 
 Once you have the dependency added, you can start using the client. The
-following is a simple example of how to connect to an EdgeDB instance and
+following is a simple example of how to connect to an Gel instance and
 execute a query:
 
 .. tabs::
@@ -123,7 +123,7 @@ schema type:
             }
         }
         
-Learn more about :ref:`data modeling <edgedb_java_datamodeling>`.
+Learn more about :ref:`data modeling <gel_java_datamodeling>`.
 
 Logging
 -------
diff --git a/docs/transactions.rst b/docs/transactions.rst
@@ -1,4 +1,4 @@
-.. _edgedb_java_transactions:
+.. _gel_java_transactions:
 
 ============
 Transactions
diff --git a/gel.toml b/gel.toml
@@ -1,2 +1,2 @@
-[edgedb]
+[gel]
 server-version = "nightly"
diff --git a/settings.gradle b/settings.gradle
@@ -1,4 +1,4 @@
-rootProject.name = 'edgedb-java'
+rootProject.name = 'gel-java'
 include 'src:driver'
 include 'tools'
 include 'tools:testgen'
diff --git a/src/driver/build.gradle b/src/driver/build.gradle
@@ -67,11 +67,11 @@ publishing {
             }
 
             pom {
-                name = 'EdgeDB Java'
-                description = 'A JVM-based binding for the EdgeDB database'
+                name = 'Gel Java'
+                description = 'A JVM-based binding for Gel'
                 url = 'https://github.com.gel/edgedb-java'
                 organization {
-                    name = 'EdgeDB'
+                    name = 'Gel'
                     url = 'https://edgedb.com'
                 }
                 issueManagement {
@@ -92,7 +92,7 @@ publishing {
                 }
                 developers {
                     developer {
-                        name = 'MagicStack Inc. and the EdgeDB authors'
+                        name = 'MagicStack Inc. and the Gel authors'
                     }
                 }
             }
diff --git a/src/driver/src/main/java/com/gel/driver/ClientType.java b/src/driver/src/main/java/com/gel/driver/ClientType.java
@@ -5,12 +5,12 @@
  */
 public enum ClientType {
     /**
-     * A TCP client using the EdgeDB Binary protocol.
+     * A TCP client using the Gel Binary protocol.
      */
     TCP,
 
     /**
-     * An HTTP client using the EdgeDB Binary protocol.
+     * An HTTP client using the Gel Binary protocol.
      */
     HTTP
 }
diff --git a/src/driver/src/main/java/com/gel/driver/ConnectionRetryMode.java b/src/driver/src/main/java/com/gel/driver/ConnectionRetryMode.java
@@ -1,7 +1,7 @@
 package com.gel.driver;
 
 /**
- * An enum that specifies retry behavior for retryable errors when connecting to EdgeDB.
+ * An enum that specifies retry behavior for retryable errors when connecting to Gel.
  */
 public enum ConnectionRetryMode {
     /**
diff --git a/src/driver/src/main/java/com/gel/driver/ErrorCode.java b/src/driver/src/main/java/com/gel/driver/ErrorCode.java
@@ -4,7 +4,7 @@
 import org.jetbrains.annotations.NotNull;
 
 /**
- * Represents different possible error codes returned by EdgeDB.
+ * Represents different possible error codes returned by Gel.
  * @see com.gel.driver.exceptions.GelErrorException
  */
 public enum ErrorCode implements BinaryEnum<Integer> {
diff --git a/src/driver/src/main/java/com/gel/driver/ErrorSeverity.java b/src/driver/src/main/java/com/gel/driver/ErrorSeverity.java
@@ -4,7 +4,7 @@
 import org.jetbrains.annotations.NotNull;
 
 /**
- * Represents the error severity for an error returned by EdgeDB
+ * Represents the error severity for an error returned by Gel
  * @see com.gel.driver.exceptions.GelErrorException
  */
 public enum ErrorSeverity implements BinaryEnum<Byte> {
diff --git a/src/driver/src/main/java/com/gel/driver/GelClientPool.java b/src/driver/src/main/java/com/gel/driver/GelClientPool.java
@@ -31,7 +31,7 @@
 import static com.gel.driver.util.ComposableUtil.composeWith;
 
 /**
- * Represents a client pool used to interact with EdgeDB.
+ * Represents a client pool used to interact with Gel.
  */
 public final class GelClientPool implements StatefulClient, GelQueryable, AutoCloseable {
     private static final Logger logger = LoggerFactory.getLogger(GelClientPool.class);
@@ -65,7 +65,7 @@ public Duration age() {
 
     /**
      * Constructs a new {@linkplain GelClientPool}.
-     * @param connection The connection parameters used to connect this client to EdgeDB.
+     * @param connection The connection parameters used to connect this client to Gel.
      * @param config The configuration for this client.
      * @throws ConfigurationException A configuration parameter is invalid.
      */
@@ -81,7 +81,7 @@ public GelClientPool(GelConnection connection, @NotNull GelClientConfig config)
 
     /**
      * Constructs a new {@linkplain GelClientPool}.
-     * @param connection The connection parameters used to connect this client to EdgeDB.
+     * @param connection The connection parameters used to connect this client to Gel.
      * @throws ConfigurationException A configuration parameter is invalid.
      */
     public GelClientPool(GelConnection connection) throws GelException {
diff --git a/src/driver/src/main/java/com/gel/driver/GelConnection.java b/src/driver/src/main/java/com/gel/driver/GelConnection.java
@@ -31,7 +31,7 @@
 import java.util.regex.Pattern;
 
 /**
- * A class containing information on how to connect to a EdgeDB instance.
+ * A class containing information on how to connect to a Gel instance.
  */
 @SuppressWarnings("CloneableClassWithoutClone")
 public class GelConnection implements Cloneable {
diff --git a/src/driver/src/main/java/com/gel/driver/GelQueryable.java b/src/driver/src/main/java/com/gel/driver/GelQueryable.java
@@ -11,7 +11,7 @@
 import java.util.concurrent.CompletionStage;
 
 /**
- * Represents a generic EdgeDB queryable interface, providing methods to execute queries with cardinality control.
+ * Represents a generic Gel queryable interface, providing methods to execute queries with cardinality control.
  * @see GelClientPool
  */
 public interface GelQueryable {
diff --git a/src/driver/src/main/java/com/gel/driver/TransactionIsolation.java b/src/driver/src/main/java/com/gel/driver/TransactionIsolation.java
@@ -17,7 +17,7 @@ public enum TransactionIsolation {
     /**
      * All statements of the current transaction can only see data committed before the first query or data-modification
      * statement was executed in this transaction.
-     * @deprecated in EdgeDB >=1.3
+     * @deprecated in Gel >=1.3
      */
     @Deprecated
     REPEATABLE_READ;
diff --git a/src/driver/src/main/java/com/gel/driver/annotations/GelName.java b/src/driver/src/main/java/com/gel/driver/annotations/GelName.java
@@ -6,7 +6,7 @@
 import java.lang.annotation.Target;
 
 /**
- * Specifies the name of the target as it's represented as in EdgeDB.
+ * Specifies the name of the target as it's represented as in Gel.
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.FIELD, ElementType.PARAMETER})
diff --git a/src/driver/src/main/java/com/gel/driver/annotations/GelType.java b/src/driver/src/main/java/com/gel/driver/annotations/GelType.java
@@ -6,7 +6,7 @@
 import java.lang.annotation.Target;
 
 /**
- * Marks the target type as a type that is represented in EdgeDB.
+ * Marks the target type as a type that is represented in Gel.
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.TYPE})
diff --git a/src/driver/src/main/java/com/gel/driver/datatypes/Json.java b/src/driver/src/main/java/com/gel/driver/datatypes/Json.java
@@ -3,7 +3,7 @@
 import org.jetbrains.annotations.NotNull;
 
 /**
- * A class representing the {@code std::json} type in EdgeDB.
+ * A class representing the {@code std::json} type in Gel.
  */
 public final class Json {
     private final @NotNull String value;
diff --git a/src/driver/src/main/java/com/gel/driver/datatypes/MultiRange.java b/src/driver/src/main/java/com/gel/driver/datatypes/MultiRange.java
@@ -5,7 +5,7 @@
 import java.util.HashSet;
 
 /**
- * Represents the {@code multirange} type in EdgeDB
+ * Represents the {@code multirange} type in Gel
  * @param <T> The inner type of the multirange.
  */
 @SuppressWarnings("unchecked")
diff --git a/src/driver/src/main/java/com/gel/driver/datatypes/Range.java b/src/driver/src/main/java/com/gel/driver/datatypes/Range.java
@@ -15,7 +15,7 @@
 /**
  * A class representing the {@code std::range} type.
  * @param <T> The inner type of the range.
- * @see <a href="https://www.edgedb.com/docs/stdlib/range">EdgeDB range docs</a>
+ * @see <a href="https://www.edgedb.com/docs/stdlib/range">Gel range docs</a>
  */
 public final class Range<T> {
     /**
diff --git a/src/driver/src/main/java/com/gel/driver/exceptions/GelErrorException.java b/src/driver/src/main/java/com/gel/driver/exceptions/GelErrorException.java
diff --git a/src/driver/src/main/java/com/gel/driver/exceptions/GelException.java b/src/driver/src/main/java/com/gel/driver/exceptions/GelException.java

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-.. _edgedb_java_transactions:`
	`1`	`+.. _gel_java_transactions:`
`2`	`2`
`3`	`3`	`============`
`4`	`4`	`Transactions`