|
1 | 1 | import { TableOrRawTableOptions } from './Table.js'; |
2 | 2 |
|
3 | 3 | /** |
4 | | - * A pending variant of a {@link RawTable} that doesn't have a name (because it would be inferred when creating the |
5 | | - * schema). |
| 4 | + * Instructs PowerSync to sync data into a "raw" table. |
| 5 | + * |
| 6 | + * Since raw tables are not backed by JSON, running complex queries on them may be more efficient. Further, they allow |
| 7 | + * using client-side table and column constraints. |
| 8 | + * |
| 9 | + * To collect local writes to raw tables with PowerSync, custom triggers are required. See |
| 10 | + * {@link https://docs.powersync.com/usage/use-case-examples/raw-tables the documentation} for details and an example on |
| 11 | + * using raw tables. |
| 12 | + * |
| 13 | + * Note that raw tables are only supported when using the new `SyncClientImplementation.rust` sync client. |
| 14 | + * |
| 15 | + * @experimental Please note that this feature is experimental at the moment, and not covered by PowerSync semver or |
| 16 | + * stability guarantees. |
6 | 17 | */ |
7 | 18 | export type RawTableType = RawTableTypeWithStatements | InferredRawTableType; |
8 | 19 |
|
@@ -64,19 +75,7 @@ export type PendingStatement = { |
64 | 75 | }; |
65 | 76 |
|
66 | 77 | /** |
67 | | - * Instructs PowerSync to sync data into a "raw" table. |
68 | | - * |
69 | | - * Since raw tables are not backed by JSON, running complex queries on them may be more efficient. Further, they allow |
70 | | - * using client-side table and column constraints. |
71 | | - * |
72 | | - * To collect local writes to raw tables with PowerSync, custom triggers are required. See |
73 | | - * {@link https://docs.powersync.com/usage/use-case-examples/raw-tables the documentation} for details and an example on |
74 | | - * using raw tables. |
75 | | - * |
76 | | - * Note that raw tables are only supported when using the new `SyncClientImplementation.rust` sync client. |
77 | | - * |
78 | | - * @experimental Please note that this feature is experimental at the moment, and not covered by PowerSync semver or |
79 | | - * stability guarantees. |
| 78 | + * @internal |
80 | 79 | */ |
81 | 80 | export type RawTable<T extends RawTableType = RawTableType> = T & { |
82 | 81 | /** |
|
0 commit comments