Docs update

Author: simolus3

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## 1.3.0 (unreleased)
 
 * Support tables created outside of PowerSync with the `RawTable` API.
+  For more information, see [the documentation](https://docs.powersync.com/usage/use-case-examples/raw-tables).
 * Fix `runWrapped` catching cancellation exceptions.
 
 ## 1.2.2

core/src/commonMain/kotlin/com/powersync/db/schema/RawTable.kt

@@ -18,6 +18,9 @@ import kotlinx.serialization.json.put
  *
  * A main benefit of raw tables is that, since they're not backed by JSON views, complex queries on
  * them can be much more efficient.
+ * However, it's the responsibility of the developer to create these raw tables, migrate them when necessary and to
+ * write triggers detecting local writes. For more information, see
+ * [the documentation page](https://docs.powersync.com/usage/use-case-examples/raw-tables).
  *
  * Note that raw tables are only supported when [SyncOptions.newClientImplementation] is enabled.
  */

core/src/commonMain/kotlin/com/powersync/db/schema/Schema.kt

@@ -11,6 +11,7 @@ import kotlinx.serialization.json.JsonElement
  * The implementation uses the schema as a "VIEW" on top of JSON data.
  * No migrations are required on the client.
  */
+@ConsistentCopyVisibility
 @OptIn(ExperimentalPowerSyncAPI::class)
 public data class Schema internal constructor(
     val tables: List<Table>,
@@ -31,10 +32,14 @@ public data class Schema internal constructor(
             yieldAll(rawTables)
         }
 
+    // Kept for binary compatibility, the new constructor taking a BaseTable vararg will be used when recompiling.
+    @Deprecated(level = DeprecationLevel.HIDDEN, message = "Use constructor taking BaseTable args instead")
+    public constructor(vararg tables: Table) : this(tables.asList())
+
     /**
      * Secondary constructor to create a schema with a variable number of tables.
      */
-    public constructor(vararg tables: Table) : this(tables.asList())
+    public constructor(vararg tables: BaseTable) : this(tables.asList())
 
     /**
      * Validates the schema by ensuring there are no duplicate table names

core/src/commonMain/kotlin/com/powersync/sync/SyncStream.kt

@@ -441,6 +441,10 @@ internal class SyncStream(
         val scope: CoroutineScope,
     ) {
         suspend fun streamingSyncIteration() {
+            check(schema.rawTables.isEmpty()) {
+                "Raw tables are only supported by the Rust sync client."
+            }
+
             val bucketEntries = bucketStorage.getBucketStates()
             val initialBuckets = mutableMapOf<String, String>()