Update some docs for 2.0 (#4438)

- Schema version type changed to Long
 - Document optimistic locking
 - Remove the old upgrading docs
 - Fix the retrieved type information for mysql and postgres
 - Fix banner to link even from inner pages

docs/common/custom_column_types.md

@@ -52,3 +52,13 @@ val queryWrapper: Database = Database(
   )
 )
 ```
+
+## Value types
+
+SQLDelight can generate a value type for a column which wraps the underlying database type if requested:
+
+```sql
+CREATE TABLE hockeyPlayer (
+  id INT AS VALUE
+);
+```

docs/common/types_server_migrations.md

@@ -1,3 +1,28 @@
+## Optimistic Locking
+
+If you specify a column as a `LOCK`, it would have a value type generated for it, and also require
+that `UPDATE` statements correctly use the lock to perform updates.
+
+```sql
+CREATE TABLE hockeyPlayer(
+  id INT AS VALUE,
+  version_number INT AS LOCK,
+  nmae VARCHAR(8)
+);
+
+-- This will fail (and the IDE plugin will suggest rewriting to the below)
+updateName:
+UPDATE hockeyPlayer
+SET name = ?;
+
+-- This will pass compilation
+updateNamePassing:
+UPDATE hockeyPlayer
+SET name = ?
+    version_number = :version_number + 1
+WHERE version_number = :version_number;
+```
+
 ## Custom Types in Migrations
 
 If migrations are the schema's source of truth, you can also specify

docs/jvm_mysql/types.md

@@ -5,24 +5,25 @@ which specifies the Kotlin type of the column in the generated interface.
 
 ```sql
 CREATE TABLE some_types (
-  some_tiny_int TINYINT,             -- Retrieved as Int
-  some_small_int SMALLINT,           -- Retrieved as Int
+  some_bit BIT,                      -- Retrieved as Boolean
+  some_tiny_int TINYINT,             -- Retrieved as Byte 
+  some_small_int SMALLINT,           -- Retrieved as Short
   some_medium_int MEDIUMINT,         -- Retrieved as Int
   some_integer INTEGER,              -- Retrieved as Int
   some_int INT,                      -- Retrieved as Int
   some_big_int BIGINT,               -- Retrieved as Long
   some_decimal DECIMAL,              -- Retrieved as Double
   some_dec DEC,                      -- Retrieved as Double
   some_fixed FIXED,                  -- Retrieved as Double
-  some_numeric NUMERIC,              -- Retrieved as Double
+  some_numeric NUMERIC,              -- Retrieved as BigDecimal
   some_float FLOAT,                  -- Retrieved as Double
   some_real REAL,                    -- Retrieved as Double
   some_double_prec DOUBLE PRECISION, -- Retrieved as Double
   some_double DOUBLE,                -- Retrieved as Double
-  some_date DATE,                    -- Retrieved as String
-  some_time TIME,                    -- Retrieved as String
-  some_datetime DATETIME,            -- Retrieved as String
-  some_timestamp TIMESTAMP,          -- Retrieved as String
+  some_date DATE,                    -- Retrieved as LocalDate
+  some_time TIME,                    -- Retrieved as LocalTime
+  some_datetime DATETIME,            -- Retrieved as LocalDateTime
+  some_timestamp TIMESTAMP,          -- Retrieved as OffsetDateTime
   some_year YEAR,                    -- Retrieved as String
   some_char CHAR,                    -- Retrieved as String
   some_varchar VARCHAR(16),          -- Retrieved as String

docs/jvm_postgresql/types.md

@@ -13,7 +13,7 @@ CREATE TABLE some_types (
   some_int4 INT4,                       -- Retrieved as Int
   some_bigint BIGINT,                   -- Retrieved as Long
   some_int8 INT8,                       -- Retrieved as Long
-  some_numeric NUMERIC,                 -- Retrieved as Double
+  some_numeric NUMERIC,                 -- Retrieved as BigDecimal
   some_decimal DECIMAL,                 -- Retrieved as Double
   some_real REAL,                       -- Retrieved as Double
   some_float4 FLOAT4,                   -- Retrieved as Double
@@ -30,10 +30,13 @@ CREATE TABLE some_types (
   some_char_var CHARACTER VARYING(16),  -- Retrieved as String
   some_varchar VARCHAR(16),             -- Retrieved as String
   some_text TEXT,                       -- Retrieved as String
-  some_date DATE,                       -- Retrieved as String
-  some_time TIME,                       -- Retrieved as String
-  some_timestamp TIMESTAMP,             -- Retrieved as String
+  some_date DATE,                       -- Retrieved as LocalDate
+  some_time TIME,                       -- Retrieved as LocalTime
+  some_timestamp TIMESTAMP,             -- Retrieved as LocalDateTime
+  some_timestamp TIMESTAMPTZ,           -- Retrieved as OffsetDateTime
   some_json JSON                        -- Retrieved as String
+  some_interval INTERVAL                -- Retrieved as PGInterval
+  some_uuid UUID                        -- Retrieved as UUID
 );
 ```
 

docs/overrides/main.html

@@ -1,5 +1,5 @@
 {% extends "base.html" %}
 
 {% block announce %}
-   SQLDelight 2.0 is now available! See <a href="upgrading-2.0">the docs</a> on migrating.
+   SQLDelight 2.0 is now available! See <a href="/sqldelight/upgrading-2.0">the docs</a> on migrating.
 {% endblock %}

docs/upgrading-2.0.md

@@ -146,3 +146,4 @@ dependencies {
   * The [`next()`](../2.x/runtime/app.cash.sqldelight.db/-sql-cursor/next) method on the `SqlCursor` interface has also been changed to return a `QueryResult` to enable better cursor support for asynchronous drivers.
 * The [`SqlSchema`](../2.x/runtime/app.cash.sqldelight.db/-sql-schema) interface now has a generic `QueryResult` type parameter. This is used to distinguish schema runtimes that were generated for use with asynchronous drivers, which may not be directly compatible with synchronous drivers.
   This is only relevant for projects that are simultaneously using synchronous and asynchronous drivers together, like in a multiplatform project that has a JS target. See "[Multiplatform setup with the Web Worker Driver](js_sqlite/multiplatform.md)" for more details.
+* The type of `SqlSchema.Version` changed from Int to Long to allow for server environments to leverage timestamps as version. Existing setups can safely cast between from Int and Long, and drivers that require an Int range for versions will crash before database creation for out of bounds versions.

mkdocs.yml

@@ -32,7 +32,6 @@ nav:
     - 'Testing': android_sqlite/testing.md
     - 'IntelliJ Plugin': android_sqlite/intellij_plugin.md
     - 'Gradle': android_sqlite/gradle.md
-    - 'Upgrading Pre-1.0': android_sqlite/upgrading.md
     - '2.x API':
         - 'coroutines-extensions': 2.x/extensions/coroutines-extensions/index.html
         - 'rxjava2-extensions': 2.x/extensions/rxjava2-extensions/index.html