Skip to main content

Quickstart

This guide takes you from zero to a working Lark connection in under five minutes. You’ll connect to a database, write data, read it back, and subscribe to real-time updates.

1. Install the SDK

2. Connect to your database

That’s it. Operations queue automatically and run once the connection is established. No need to await anything before you start using the database.
You can find your project and database IDs in the Lark dashboard. The format is always projectId/databaseId.

3. Write data

4. Read data once

5. Subscribe to real-time updates

6. Clean up

Full working example

Here’s everything in one file:

Next steps

  • Connecting: connection options, transport selection, and lifecycle events
  • Writing data: set, update, remove, push, and multi-path writes
  • Subscriptions: listen for real-time changes with different event types
  • Authentication: move beyond anonymous auth with tokens