🚀 Electric is now 1.0 and Cloud is in public BETA!
Skip to content
Main Navigation ProductUse casesDocsDemosBlogAbout
Sign-up to Cloud
Sign-up
Sign-up to Cloud
Sign-up to Cloud
Sign-up
Sign-up to Cloud
On this page

@electric-sql/docs ​

0.0.2 ​

Patch Changes ​

  • 0dd1f0c: feat: add support for parameters in where clauses to clients

  • eb8167a: Implement ELECTRIC_QUERY_DATABASE_URL optional env var to perform queries with separate, potentially pooled connection string.

  • f6a3265: Fix OpenAPI spec 409 response schema

  • f1a9247: feat!: change the wire protocol to remove offset and add an explicit lsn header. Only valid offset now is the one provided in headers

  • 4d7b8ba: Add support for shapes on partitioned tables

  • dd5aeab: This PR adds support for function-based options in the TypeScript client's params and headers. Functions can be either synchronous or asynchronous and are resolved in parallel when needed.

    typescript
    const stream = new ShapeStream({
      url: "http://localhost:3000/v1/shape",
      params: {
        table: "items",
        userId: () => getCurrentUserId(),
        filter: async () => await getUserPreferences(),
      },
      headers: {
        Authorization: async () => `Bearer ${await getAccessToken()}`,
      },
    })

    Common Use Cases ​

    • Authentication tokens that need to be refreshed
    • User-specific parameters that may change
    • Dynamic filtering based on current state
    • Multi-tenant applications where context determines the request

0.0.2-beta.3 ​

Patch Changes ​

  • f6a3265: Fix OpenAPI spec 409 response schema

0.0.2-beta.2 ​

Patch Changes ​

  • f1a9247: feat!: change the wire protocol to remove offset and add an explicit lsn header. Only valid offset now is the one provided in headers

0.0.2-beta.1 ​

Patch Changes ​

  • 4d7b8ba: Add support for shapes on partitioned tables

0.0.2-beta.0 ​

Patch Changes ​

  • dd5aeab: This PR adds support for function-based options in the TypeScript client's params and headers. Functions can be either synchronous or asynchronous and are resolved in parallel when needed.

    typescript
    const stream = new ShapeStream({
      url: "http://localhost:3000/v1/shape",
      params: {
        table: "items",
        userId: () => getCurrentUserId(),
        filter: async () => await getUserPreferences(),
      },
      headers: {
        Authorization: async () => `Bearer ${await getAccessToken()}`,
      },
    })

    Common Use Cases ​

    • Authentication tokens that need to be refreshed
    • User-specific parameters that may change
    • Dynamic filtering based on current state
    • Multi-tenant applications where context determines the request

About Contact Legal Docs Demos Blog Sign upPGliteGitHubBlueskyDiscord

Released under the Apache 2.0 License. © 2025 Electric DB Limited.