edgedb-java/docs/datatypes.rst
Quin Lynch f1e5b65a26
Add docs (#6)
* init

* Update docs/configuration.rst

Co-authored-by: Devon Campbell <devon@radworks.io>

* Update docs/configuration.rst

Co-authored-by: Devon Campbell <devon@radworks.io>

* Update docs/configuration.rst

Co-authored-by: Devon Campbell <devon@radworks.io>

* Update docs/configuration.rst

Co-authored-by: Devon Campbell <devon@radworks.io>

* Add blurb for configuration builder

* Update docs/configuration.rst

Co-authored-by: Devon Campbell <devon@radworks.io>

* Update docs/connecting.rst

Co-authored-by: Devon Campbell <devon@radworks.io>

* Update docs/connecting.rst

Co-authored-by: Devon Campbell <devon@radworks.io>

* Update docs/connecting.rst

Co-authored-by: Devon Campbell <devon@radworks.io>

* Update docs/connecting.rst

Co-authored-by: Devon Campbell <devon@radworks.io>

* Update docs/datamodeling.rst

Co-authored-by: Devon Campbell <devon@radworks.io>

* Update docs/datamodeling.rst

Co-authored-by: Devon Campbell <devon@radworks.io>

* Update docs/datamodeling.rst

Co-authored-by: Devon Campbell <devon@radworks.io>

* Update docs/datamodeling.rst

Co-authored-by: Devon Campbell <devon@radworks.io>

* Update docs/datamodeling.rst

Co-authored-by: Devon Campbell <devon@radworks.io>

* Update docs/datamodeling.rst

Co-authored-by: Devon Campbell <devon@radworks.io>

* Update docs/datamodeling.rst

Co-authored-by: Devon Campbell <devon@radworks.io>

* Update docs/datamodeling.rst

Co-authored-by: Devon Campbell <devon@radworks.io>

* Update docs/datamodeling.rst

Co-authored-by: Devon Campbell <devon@radworks.io>

* Update docs/datamodeling.rst

Co-authored-by: Devon Campbell <devon@radworks.io>

* Update docs/datamodeling.rst

Co-authored-by: Devon Campbell <devon@radworks.io>

* Update docs/datamodeling.rst

Co-authored-by: Devon Campbell <devon@radworks.io>

* add explicit type to ObjectEnumerator section

* Update docs/datamodeling.rst

Co-authored-by: Devon Campbell <devon@radworks.io>

* Update docs/datatypes.rst

Co-authored-by: Devon Campbell <devon@radworks.io>

* change datatype notes to footnotes

* rename "Type" to "Parameters"

* reword blurb on reflection

* add schema 2.x and 3+ tabs

---------

Co-authored-by: Devon Campbell <devon@radworks.io>
2023-06-13 12:08:04 -03:00

65 lines
5.2 KiB
ReStructuredText

.. _edgedb_java_datatypes:
=========
Datatypes
=========
The Java binding maps the following EdgeDB types to corresponding JVM types:
+------------------------------------+---------------------------------------------------------+
| EdgeDB Type | JVM Type |
+====================================+=========================================================+
| ``Set`` | ``Collection<T>`` |
+------------------------------------+---------------------------------------------------------+
| :eql:type:`array` | ``T[]`` |
+------------------------------------+---------------------------------------------------------+
| :eql:type:`anytuple` | ``com.edgedb.driver.datatypes.Tuple`` |
+------------------------------------+---------------------------------------------------------+
| :eql:type:`anyenum` | ``enum`` |
+------------------------------------+---------------------------------------------------------+
| :eql:type:`Object` | ``Object`` |
+------------------------------------+---------------------------------------------------------+
| :eql:type:`bool` | ``boolean`` |
+------------------------------------+---------------------------------------------------------+
| :eql:type:`bytes` | ``byte[]`` |
+------------------------------------+---------------------------------------------------------+
| :eql:type:`str` | ``String`` |
+------------------------------------+---------------------------------------------------------+
| :eql:type:`cal::local_date` | ``java.time.LocalDate`` |
+------------------------------------+---------------------------------------------------------+
| :eql:type:`cal::local_time` | ``java.time.LocalTime`` |
+------------------------------------+---------------------------------------------------------+
| :eql:type:`cal::local_datetime` | ``java.time.LocalDateTime`` |
+------------------------------------+---------------------------------------------------------+
| :eql:type:`cal::relative_duration` | ``com.edgedb.driver.datatypes.RelativeDuration`` [#f1]_ |
+------------------------------------+---------------------------------------------------------+
| :eql:type:`datetime` | ``java.time.OffsetDateTime`` [#f2]_ |
+------------------------------------+---------------------------------------------------------+
| :eql:type:`duration` | ``java.time.Duration`` |
+------------------------------------+---------------------------------------------------------+
| :eql:type:`float32` | ``float`` |
+------------------------------------+---------------------------------------------------------+
| :eql:type:`float64` | ``double`` |
+------------------------------------+---------------------------------------------------------+
| :eql:type:`int16` | ``short`` |
+------------------------------------+---------------------------------------------------------+
| :eql:type:`int32` | ``int`` |
+------------------------------------+---------------------------------------------------------+
| :eql:type:`int64` | ``long`` |
+------------------------------------+---------------------------------------------------------+
| :eql:type:`bigint` | ``java.math.BigInteger`` |
+------------------------------------+---------------------------------------------------------+
| :eql:type:`decimal` | ``java.math.BigDecimal`` |
+------------------------------------+---------------------------------------------------------+
| :eql:type:`json` | ``com.edgedb.driver.datatypes.Json`` |
+------------------------------------+---------------------------------------------------------+
| :eql:type:`uuid` | ``UUID`` |
+------------------------------------+---------------------------------------------------------+
| :eql:func:`range` | ``com.edgedb.driver.datatypes.Range`` |
+------------------------------------+---------------------------------------------------------+
.. [#f1] ``Period`` and ``Duration`` are implicitly
converted to and from ``RelativeDuration``.
.. [#f2] Both ``java.time.OffsetDateTime`` and
``java.time.ZonedDateTime`` are compatable.