Skip to content

Kotlin samples pass connect options via SyncOptions #737

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mintlify wants to merge 1 commit into from
Closed

Kotlin samples pass connect options via SyncOptions #737

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions configuration/app-backend/client-side-integration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ The default throttle interval varies by SDK:
| SDK | Default | Option Name |
| --- | --- | --- |
| JavaScript / React Native / Node / Capacitor / Tauri | 1,000 ms | `crudUploadThrottleMs` |
| Kotlin | 1,000 ms | `crudThrottleMs` |
| Kotlin | 1 second | `crudThrottle` (`Duration`) |
| Swift | 1 second | `crudThrottle` (seconds) |
| .NET | 1,000 ms | `CrudUploadThrottleMs` |
| Dart / Flutter | 10 ms | `crudThrottleTime` |
Expand All @@ -85,7 +85,11 @@ db.connect(
```

```kotlin Kotlin
database.connect(connector, crudThrottleMs = 500L)
// Requires Kotlin SDK 1.16.0 or later
database.connect(
connector,
options = SyncOptions(crudThrottle = 500.milliseconds),
)
```

```swift Swift
Expand Down
11 changes: 8 additions & 3 deletions maintenance-ops/monitoring-and-alerting.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@

#### Excluding Results

Prefix a term or filter with `-` to exclude matching entries. This is useful for hiding known-noisy errors while triaging:

Check warning on line 172 in maintenance-ops/monitoring-and-alerting.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

maintenance-ops/monitoring-and-alerting.mdx#L172 

Did you really mean 'triaging'?

```text
-error:PSYNC_S2106
Expand Down Expand Up @@ -320,6 +320,7 @@
```kotlin
import com.powersync.DatabaseDriverFactory
import com.powersync.PowerSyncDatabase
import com.powersync.sync.SyncOptions

// Android
val driverFactory = DatabaseDriverFactory(this)
Expand All @@ -333,11 +334,15 @@
})

// Set custom metadata when connecting
// Requires Kotlin SDK 1.16.0 or later.
// On earlier versions, pass appMetadata directly to connect().
powerSync.connect(
connector = MyConnector(),
appMetadata = mapOf(
"app_version" to "1.2.3",
"feature_flag" to "new_sync_flow"
options = SyncOptions(
appMetadata = mapOf(
"app_version" to "1.2.3",
"feature_flag" to "new_sync_flow"
)
)
)
```
Expand Down
5 changes: 4 additions & 1 deletion sync/streams/client-usage.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -556,9 +556,12 @@ Set connection parameters when connecting:
</Tab>
<Tab title="Kotlin">
```kotlin
// Requires Kotlin SDK 1.16.0 or later
database.connect(
connector,
params = mapOf("environment" to JsonParam.String("production"))
options = SyncOptions(
params = mapOf("environment" to JsonParam.String("production"))
)
)
```
</Tab>
Expand Down
Loading