Skip to content

feat: Added attachmentTableName option #535

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

Merged
merged 1 commit into from
Mar 19, 2025
Merged

feat: Added attachmentTableName option #535

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
5 changes: 5 additions & 0 deletions .changeset/slimy-mice-invite.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@powersync/attachments': minor
---

Added `attachmentTableName` option to attachment queue which allows you to specify the table name it should work with.
12 changes: 9 additions & 3 deletions packages/attachments/src/AbstractAttachmentQueue.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,14 @@ export interface AttachmentQueueOptions {
*/
cacheLimit?: number;
/**
* The name of the directory where attachments are stored on the device, not the full path
* The name of the directory where attachments are stored on the device, not the full path. Defaults to `attachments`.
*/
attachmentDirectoryName?: string;

/**
* The name of the table where attachments are stored, defaults to `attachments` table.
*/
attachmentTableName?: string;
/**
* Whether to mark the initial watched attachment IDs to be synced
*/
Expand All @@ -36,7 +41,8 @@ export interface AttachmentQueueOptions {
}

export const DEFAULT_ATTACHMENT_QUEUE_OPTIONS: Partial<AttachmentQueueOptions> = {
attachmentDirectoryName: 'attachments',
attachmentDirectoryName: ATTACHMENT_TABLE,
attachmentTableName: ATTACHMENT_TABLE,
syncInterval: 30_000,
cacheLimit: 100,
performInitialSync: true,
Expand Down Expand Up @@ -90,7 +96,7 @@ export abstract class AbstractAttachmentQueue<T extends AttachmentQueueOptions =
}

get table() {
return ATTACHMENT_TABLE;
return this.options.attachmentTableName!;
}

async init() {
Expand Down