Skip to content

README.md

Latest commit

 

History

History
107 lines (89 loc) · 3.58 KB

README.md

File metadata and controls

107 lines (89 loc) · 3.58 KB
Raw

Entity Framework Core support for Syncerbell

Configuration

services.AddSyncerbellEntityFrameworkCorePersistence(options => 
{
    options.WithDbContextOptions(dbContextOptions =>
    {
        dbContextOptions.UseSqlServer()
            .EnableRetryOnFailure();
    });
});

Table Schema

CREATE TABLE [dbo].[SyncLogEntries] (
    Id int NOT NULL IDENTITY(1, 1),
    Entity varchar(100) NOT NULL,
    ParametersJson nvarchar(100) NULL,
    SchemaVersion int NULL,
    TriggerType int NOT NULL CONSTRAINT [DF_SyncLogEntries_TriggerType] DEFAULT 0,
    SyncStatus int NOT NULL CONSTRAINT [DF_SyncLogEntries_SyncStatus] DEFAULT 1,
    CreatedAt datetime2 NOT NULL CONSTRAINT [DF_SyncLogEntries_CreatedAt] DEFAULT GETUTCDATE(),
    LeasedAt datetime2 NULL,
    LeaseExpiresAt datetime2 NULL,
    LeasedBy varchar(100) NULL,
    QueueMessageId varchar(100) NULL,
    QueuedAt datetime2 NULL,
    FinishedAt datetime2 NULL,
    ResultMessage nvarchar(MAX) NULL,
    HighWaterMark varchar(100) NULL,
    ProgressValue int NULL,
    ProgressMax int NULL,
    RecordCount int NULL,
    RowVersion rowversion,
    CONSTRAINT [PK_SyncLogEntries] PRIMARY KEY CLUSTERED ([Id]),
    CONSTRAINT [CK_SyncLogEntries_LeasedAt_LeaseExpiresAt] CHECK (
        ([LeasedAt] IS NULL AND [LeaseExpiresAt] IS NULL) OR
        ([LeasedAt] IS NOT NULL AND [LeaseExpiresAt] IS NOT NULL)
    ),
)
GO

CREATE UNIQUE NONCLUSTERED INDEX [IX_SyncLogEntries_Entity_ParametersJson_SchemaVersion_SyncStatus]
    ON [dbo].[SyncLogEntries]([Entity], [ParametersJson], [SchemaVersion], [SyncStatus])
    WHERE [SyncStatus] IN (1, 2)
GO

CREATE NONCLUSTERED INDEX [IX_SyncLogEntries_Entity_ParametersJson_SchemaVersion]
    ON [dbo].[SyncLogEntries]([Entity], [ParametersJson], [SchemaVersion])
GO

Migrating to 0.3.0

The 0.3.0 release adds the SchemaVersion column to the SyncLogEntries table. If you are upgrading from 0.2.0 and not using dacpac deployment, you need to run the following SQL script to add the new column and index:

DROP INDEX IF EXISTS [IX_SyncLogEntries_Entity_ParametersJson_SyncStatus] ON [dbo].[SyncLogEntries];
GO

DROP INDEX IF EXISTS [IX_SyncLogEntries_Entity_ParametersJson] ON [dbo].[SyncLogEntries];
GO

ALTER TABLE [dbo].[SyncLogEntries]
ADD [SchemaVersion] int NULL;
GO

CREATE UNIQUE NONCLUSTERED INDEX [IX_SyncLogEntries_Entity_ParametersJson_SchemaVersion_SyncStatus]
    ON [dbo].[SyncLogEntries]([Entity], [ParametersJson], [SchemaVersion], [SyncStatus])
    WHERE [SyncStatus] IN (1, 2);
GO

CREATE NONCLUSTERED INDEX [IX_SyncLogEntries_Entity_ParametersJson_SchemaVersion]
    ON [dbo].[SyncLogEntries]([Entity], [ParametersJson], [SchemaVersion]);
GO

Migrating to 0.5.0

The 0.5.0 release adds several new columns to the SyncLogEntries table for enhanced tracking capabilities:

  • TriggerType for tracking the type of trigger that initiated the sync operation
  • ProgressValue for tracking current progress amount
  • ProgressMax for tracking maximum progress value
  • RecordCount for tracking total number of records processed
  • QueueMessageId for tracking message IDs when fanning out sync operations via a queue
  • QueuedAt for tracking when sync operations are queued

If you are upgrading from an earlier version and not using dacpac deployment, you need to run the following SQL script to add the new columns:

ALTER TABLE [dbo].[SyncLogEntries]
ADD [TriggerType] int NOT NULL CONSTRAINT [DF_SyncLogEntries_TriggerType] DEFAULT 0,
    [ProgressValue] int NULL,
    [ProgressMax] int NULL,
    [RecordCount] int NULL,
    [QueueMessageId] varchar(100) NULL,
    [QueuedAt] datetime2 NULL;
GO