tursodatabase / tursodatabase/libsql-client-ts

How to use SQLCipher?

Open
#292 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
576
Forks
69
PR merge metrics
No merged PRs in 30d

Description

If I use the following code to create DB, it use WxSQLite3, the doc says the default is SQLCipher, how to change to SQLCipher?

const encryptionKey = "my-safe-encryption-key";

const client = createClient({
    url: "file:encrypted.db",
    encryptionKey,
});

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the createClient usage shown in the issue and read the linked libSQL encryption-at-rest documentation. Determine how this client selects or configures the encryption backend, then document the supported SQLCipher setup with a verified example using encrypted.db as the completion criterion.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, sqlite, typescript
Domain
database, security
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.