@powersync/service-module-mysql 0.0.0-dev-20241015210820

package/CHANGELOG.md

@@ -0,0 +1,20 @@
+# @powersync/service-module-mysql
+
+## 0.0.0-dev-20241015210820
+
+### Patch Changes
+
+- Updated dependencies [e4d19b2]
+- Updated dependencies [d2ece1b]
+- Updated dependencies [d2ece1b]
+- Updated dependencies [9e78ff1]
+- Updated dependencies [d2ece1b]
+- Updated dependencies [1fd50a5]
+- Updated dependencies [d51921f]
+- Updated dependencies [4ecaee2]
+- Updated dependencies [0e16938]
+- Updated dependencies [aa4eb0a]
+  - @powersync/service-core@0.0.0-dev-20241015210820
+  - @powersync/lib-services-framework@0.0.0-dev-20241015210820
+  - @powersync/service-sync-rules@0.0.0-dev-20241015210820
+  - @powersync/service-types@0.0.0-dev-20241015210820

package/LICENSE

@@ -0,0 +1,67 @@
+# Functional Source License, Version 1.1, Apache 2.0 Future License
+
+## Abbreviation
+
+FSL-1.1-Apache-2.0
+
+## Notice
+
+Copyright 2023-2024 Journey Mobile, Inc.
+
+## Terms and Conditions
+
+### Licensor ("We")
+
+The party offering the Software under these Terms and Conditions.
+
+### The Software
+
+The "Software" is each version of the software that we make available under these Terms and Conditions, as indicated by our inclusion of these Terms and Conditions with the Software.
+
+### License Grant
+
+Subject to your compliance with this License Grant and the Patents, Redistribution and Trademark clauses below, we hereby grant you the right to use, copy, modify, create derivative works, publicly perform, publicly display and redistribute the Software for any Permitted Purpose identified below.
+
+### Permitted Purpose
+
+A Permitted Purpose is any purpose other than a Competing Use. A Competing Use means making the Software available to others in a commercial product or service that:
+
+1. substitutes for the Software;
+2. substitutes for any other product or service we offer using the Software that exists as of the date we make the Software available; or
+3. offers the same or substantially similar functionality as the Software.
+
+Permitted Purposes specifically include using the Software:
+
+1. for your internal use and access;
+2. for non-commercial education;
+3. for non-commercial research; and
+4. in connection with professional services that you provide to a licensee using the Software in accordance with these Terms and Conditions.
+
+### Patents
+
+To the extent your use for a Permitted Purpose would necessarily infringe our patents, the license grant above includes a license under our patents. If you make a claim against any party that the Software infringes or contributes to the infringement of any patent, then your patent license to the Software ends immediately.
+
+### Redistribution
+
+The Terms and Conditions apply to all copies, modifications and derivatives of the Software.
+If you redistribute any copies, modifications or derivatives of the Software, you must include a copy of or a link to these Terms and Conditions and not remove any copyright notices provided in or with the Software.
+
+### Disclaimer
+
+THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
+IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES, EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
+
+### Trademarks
+
+Except for displaying the License Details and identifying us as the origin of the Software, you have no right under these Terms and Conditions to use our trademarks, trade names, service marks or product names.
+
+## Grant of Future License
+
+We hereby irrevocably grant you an additional license to use the Software under the Apache License, Version 2.0 that is effective on the second anniversary of the date we make the Software available. On or after that date, you may use the Software under the Apache License, Version 2.0, in which case the following will apply:
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

package/README.md

@@ -0,0 +1,3 @@
+# PowerSync MySQL Module
+
+This is a module which provides MySQL replication to PowerSync.

package/dev/.env.template

@@ -0,0 +1,2 @@
+PS_MONGO_URI=mongodb://mongo:27017/powersync_demo
+PS_PORT=8080

package/dev/README.md

@@ -0,0 +1,9 @@
+# MySQL Development Helpers
+
+This folder contains some helpers for developing with MySQL.
+
+- `./.env.template` contains basic settings to be applied to a root `.env` file
+- `./config` contains YAML configuration files for a MySQL todo list application
+- `./docker/mysql` contains a docker compose file for starting Mysql
+
+TODO this does not contain any auth or backend functionality.

package/dev/config/sync_rules.yaml

@@ -0,0 +1,12 @@
+# See Documentation for more information:
+# https://docs.powersync.com/usage/sync-rules
+# Note that changes to this file are not watched.
+# The service needs to be restarted for changes to take effect.
+
+# Note that specifying the schema is currently required due to the default
+# schema being specified as `public`, but in mysql the schema is the database name
+bucket_definitions:
+  global:
+    data:
+      - SELECT * FROM mydatabase.lists
+      - SELECT * FROM mydatabase.todos

package/dev/docker/mysql/docker-compose.yaml

@@ -0,0 +1,17 @@
+services:
+  mysql:
+    image: mysql:8.0
+    environment:
+      MYSQL_ROOT_PASSWORD: root_password
+      MYSQL_DATABASE: mydatabase
+      MYSQL_USER: myuser
+      MYSQL_PASSWORD: mypassword
+    ports:
+      - "3306:3306"
+    volumes:
+      - ./init-scripts/my.cnf:/etc/mysql/my.cnf
+      - ./init-scripts/mysql.sql:/docker-entrypoint-initdb.d/init_user.sql
+      - mysql_data:/var/lib/mysql
+
+volumes:
+  mysql_data:

package/dev/docker/mysql/init-scripts/my.cnf

@@ -0,0 +1,9 @@
+[mysqld]
+gtid_mode = ON
+enforce-gtid-consistency = ON
+# Row format required for ZongJi
+binlog_format = row
+log_bin=mysql-bin
+server-id=1
+binlog-do-db=mydatabase
+replicate-do-table=mydatabase.lists

package/dev/docker/mysql/init-scripts/mysql.sql

@@ -0,0 +1,38 @@
+-- Create a user with necessary privileges
+CREATE USER 'repl_user'@'%' IDENTIFIED BY 'good_password';
+
+-- Grant replication client privilege
+GRANT REPLICATION SLAVE, REPLICATION CLIENT, RELOAD ON *.* TO 'repl_user'@'%';
+GRANT REPLICATION SLAVE, REPLICATION CLIENT, RELOAD ON *.* TO 'myuser'@'%';
+
+-- Grant access to the specific database
+GRANT ALL PRIVILEGES ON mydatabase.* TO 'repl_user'@'%';
+
+-- Apply changes
+FLUSH PRIVILEGES;
+
+CREATE TABLE lists (
+    id CHAR(36) NOT NULL DEFAULT (UUID()), -- String UUID (36 characters)
+    created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    name TEXT NOT NULL,
+    owner_id  CHAR(36) NOT NULL,
+    PRIMARY KEY (id)
+);
+
+CREATE TABLE todos (
+    id CHAR(36) NOT NULL DEFAULT (UUID()), -- String UUID (36 characters)
+    created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    completed_at TIMESTAMP NULL,
+    description TEXT NOT NULL,
+    completed BOOLEAN NOT NULL DEFAULT FALSE,
+    created_by  CHAR(36) NULL,
+    completed_by  CHAR(36) NULL,
+    list_id  CHAR(36) NOT NULL,
+    PRIMARY KEY (id),
+    FOREIGN KEY (list_id) REFERENCES lists (id) ON DELETE CASCADE
+);
+
+-- TODO fix case where no data is present
+INSERT INTO lists (id, name, owner_id)
+VALUES 
+    (UUID(), 'Do a demo', UUID());

package/dist/api/MySQLRouteAPIAdapter.d.ts

@@ -0,0 +1,24 @@
+import { api, ParseSyncRulesOptions } from '@powersync/service-core';
+import * as sync_rules from '@powersync/service-sync-rules';
+import * as service_types from '@powersync/service-types';
+import mysql from 'mysql2/promise';
+import * as types from '../types/types.js';
+export declare class MySQLRouteAPIAdapter implements api.RouteAPI {
+    protected config: types.ResolvedConnectionConfig;
+    protected pool: mysql.Pool;
+    constructor(config: types.ResolvedConnectionConfig);
+    shutdown(): Promise<void>;
+    getSourceConfig(): Promise<service_types.configFile.ResolvedDataSourceConfig>;
+    getParseSyncRulesOptions(): ParseSyncRulesOptions;
+    getConnectionStatus(): Promise<service_types.ConnectionStatusV2>;
+    executeQuery(query: string, params: any[]): Promise<service_types.internal_routes.ExecuteSqlResponse>;
+    getDebugTablesInfo(tablePatterns: sync_rules.TablePattern[], sqlSyncRules: sync_rules.SqlSyncRules): Promise<api.PatternResult[]>;
+    protected getDebugTableInfo(tablePattern: sync_rules.TablePattern, tableName: string, syncRules: sync_rules.SqlSyncRules): Promise<service_types.TableInfo>;
+    getReplicationLag(options: api.ReplicationLagOptions): Promise<number | undefined>;
+    getReplicationHead(): Promise<string>;
+    getConnectionSchema(): Promise<service_types.DatabaseSchema[]>;
+    protected retriedQuery(options: {
+        query: string;
+        params?: any[];
+    }): Promise<[mysql.RowDataPacket[], mysql.FieldPacket[]]>;
+}

package/dist/api/MySQLRouteAPIAdapter.js

@@ -0,0 +1,311 @@
+import { storage } from '@powersync/service-core';
+import * as sync_rules from '@powersync/service-sync-rules';
+import * as service_types from '@powersync/service-types';
+import * as common from '../common/common-index.js';
+import * as mysql_utils from '../utils/mysql_utils.js';
+import { toExpressionTypeFromMySQLType } from '../common/common-index.js';
+export class MySQLRouteAPIAdapter {
+    constructor(config) {
+        this.config = config;
+        this.pool = mysql_utils.createPool(config).promise();
+    }
+    async shutdown() {
+        return this.pool.end();
+    }
+    async getSourceConfig() {
+        return this.config;
+    }
+    getParseSyncRulesOptions() {
+        return {
+            // In MySQL Schema and Database are the same thing. There is no default database
+            defaultSchema: this.config.database
+        };
+    }
+    async getConnectionStatus() {
+        const base = {
+            id: this.config.id,
+            uri: `mysql://${this.config.hostname}:${this.config.port}/${this.config.database}`
+        };
+        try {
+            await this.retriedQuery({
+                query: `SELECT 'PowerSync connection test'`
+            });
+        }
+        catch (e) {
+            return {
+                ...base,
+                connected: false,
+                errors: [{ level: 'fatal', message: `${e.code} - message: ${e.message}` }]
+            };
+        }
+        const connection = await this.pool.getConnection();
+        try {
+            const errors = await common.checkSourceConfiguration(connection);
+            if (errors.length) {
+                return {
+                    ...base,
+                    connected: true,
+                    errors: errors.map((e) => ({ level: 'fatal', message: e }))
+                };
+            }
+        }
+        catch (e) {
+            return {
+                ...base,
+                connected: true,
+                errors: [{ level: 'fatal', message: e.message }]
+            };
+        }
+        finally {
+            connection.release();
+        }
+        return {
+            ...base,
+            connected: true,
+            errors: []
+        };
+    }
+    async executeQuery(query, params) {
+        if (!this.config.debug_api) {
+            return service_types.internal_routes.ExecuteSqlResponse.encode({
+                results: {
+                    columns: [],
+                    rows: []
+                },
+                success: false,
+                error: 'SQL querying is not enabled'
+            });
+        }
+        try {
+            const [results, fields] = await this.pool.query(query, params);
+            return service_types.internal_routes.ExecuteSqlResponse.encode({
+                success: true,
+                results: {
+                    columns: fields.map((c) => c.name),
+                    rows: results.map((row) => {
+                        /**
+                         * Row will be in the format:
+                         * @rows: [ { test: 2 } ]
+                         */
+                        return fields.map((c) => {
+                            const value = row[c.name];
+                            const sqlValue = sync_rules.toSyncRulesValue(value);
+                            if (typeof sqlValue == 'bigint') {
+                                return Number(value);
+                            }
+                            else if (value instanceof Date) {
+                                return value.toISOString();
+                            }
+                            else if (sync_rules.isJsonValue(sqlValue)) {
+                                return sqlValue;
+                            }
+                            else {
+                                return null;
+                            }
+                        });
+                    })
+                }
+            });
+        }
+        catch (e) {
+            return service_types.internal_routes.ExecuteSqlResponse.encode({
+                results: {
+                    columns: [],
+                    rows: []
+                },
+                success: false,
+                error: e.message
+            });
+        }
+    }
+    async getDebugTablesInfo(tablePatterns, sqlSyncRules) {
+        let result = [];
+        for (let tablePattern of tablePatterns) {
+            const schema = tablePattern.schema;
+            let patternResult = {
+                schema: schema,
+                pattern: tablePattern.tablePattern,
+                wildcard: tablePattern.isWildcard
+            };
+            result.push(patternResult);
+            if (tablePattern.isWildcard) {
+                patternResult.tables = [];
+                const prefix = tablePattern.tablePrefix;
+                const [results] = await this.pool.query(`SELECT
+            TABLE_NAME AS table_name
+           FROM 
+            INFORMATION_SCHEMA.TABLES
+           WHERE 
+            TABLE_SCHEMA = ?
+            AND TABLE_NAME LIKE ?`, [schema, tablePattern.tablePattern]);
+                for (let row of results) {
+                    const name = row.table_name;
+                    if (!name.startsWith(prefix)) {
+                        continue;
+                    }
+                    const details = await this.getDebugTableInfo(tablePattern, name, sqlSyncRules);
+                    patternResult.tables.push(details);
+                }
+            }
+            else {
+                const [results] = await this.pool.query(`SELECT
+            TABLE_NAME AS table_name
+           FROM 
+            INFORMATION_SCHEMA.TABLES
+           WHERE 
+            TABLE_SCHEMA = ?
+            AND TABLE_NAME = ?`, [tablePattern.schema, tablePattern.tablePattern]);
+                if (results.length == 0) {
+                    // Table not found
+                    patternResult.table = await this.getDebugTableInfo(tablePattern, tablePattern.name, sqlSyncRules);
+                }
+                else {
+                    const row = results[0];
+                    patternResult.table = await this.getDebugTableInfo(tablePattern, row.table_name, sqlSyncRules);
+                }
+            }
+        }
+        return result;
+    }
+    async getDebugTableInfo(tablePattern, tableName, syncRules) {
+        const { schema } = tablePattern;
+        let idColumnsResult = null;
+        let idColumnsError = null;
+        let connection = null;
+        try {
+            connection = await this.pool.getConnection();
+            idColumnsResult = await common.getReplicationIdentityColumns({
+                connection: connection,
+                schema,
+                table_name: tableName
+            });
+        }
+        catch (ex) {
+            idColumnsError = { level: 'fatal', message: ex.message };
+        }
+        finally {
+            connection?.release();
+        }
+        const idColumns = idColumnsResult?.columns ?? [];
+        const sourceTable = new storage.SourceTable(0, this.config.tag, tableName, schema, tableName, idColumns, true);
+        const syncData = syncRules.tableSyncsData(sourceTable);
+        const syncParameters = syncRules.tableSyncsParameters(sourceTable);
+        if (idColumns.length == 0 && idColumnsError == null) {
+            let message = `No replication id found for ${sourceTable.qualifiedName}. Replica identity: ${idColumnsResult?.identity}.`;
+            if (idColumnsResult?.identity == 'default') {
+                message += ' Configure a primary key on the table.';
+            }
+            idColumnsError = { level: 'fatal', message };
+        }
+        let selectError = null;
+        try {
+            await this.retriedQuery({
+                query: `SELECT * FROM ${sourceTable.table} LIMIT 1`
+            });
+        }
+        catch (e) {
+            selectError = { level: 'fatal', message: e.message };
+        }
+        return {
+            schema: schema,
+            name: tableName,
+            pattern: tablePattern.isWildcard ? tablePattern.tablePattern : undefined,
+            replication_id: idColumns.map((c) => c.name),
+            data_queries: syncData,
+            parameter_queries: syncParameters,
+            errors: [idColumnsError, selectError].filter((error) => error != null)
+        };
+    }
+    async getReplicationLag(options) {
+        const { bucketStorage } = options;
+        const lastCheckpoint = await bucketStorage.getCheckpoint();
+        const current = lastCheckpoint.lsn
+            ? common.ReplicatedGTID.fromSerialized(lastCheckpoint.lsn)
+            : common.ReplicatedGTID.ZERO;
+        const connection = await this.pool.getConnection();
+        const head = await common.readExecutedGtid(connection);
+        const lag = await current.distanceTo(connection, head);
+        connection.release();
+        if (lag == null) {
+            throw new Error(`Could not determine replication lag`);
+        }
+        return lag;
+    }
+    async getReplicationHead() {
+        const connection = await this.pool.getConnection();
+        const result = await common.readExecutedGtid(connection);
+        connection.release();
+        return result.comparable;
+    }
+    async getConnectionSchema() {
+        const [results] = await this.retriedQuery({
+            query: `
+        SELECT 
+          tbl.schema_name,
+          tbl.table_name,
+          tbl.quoted_name,
+          JSON_ARRAYAGG(JSON_OBJECT('column_name', a.column_name, 'data_type', a.data_type)) AS columns
+        FROM
+          (
+            SELECT 
+              TABLE_SCHEMA AS schema_name,
+              TABLE_NAME AS table_name,
+              CONCAT('\`', TABLE_SCHEMA, '\`.\`', TABLE_NAME, '\`') AS quoted_name
+            FROM 
+              INFORMATION_SCHEMA.TABLES
+            WHERE 
+              TABLE_TYPE = 'BASE TABLE'
+              AND TABLE_SCHEMA NOT IN ('information_schema', 'mysql', 'performance_schema', 'sys')
+          ) AS tbl
+          LEFT JOIN 
+            (
+              SELECT 
+                TABLE_SCHEMA AS schema_name,
+                TABLE_NAME AS table_name,
+                COLUMN_NAME AS column_name,
+                COLUMN_TYPE AS data_type
+              FROM 
+                INFORMATION_SCHEMA.COLUMNS
+            ) AS a 
+            ON 
+              tbl.schema_name = a.schema_name 
+              AND tbl.table_name = a.table_name
+        GROUP BY 
+          tbl.schema_name, tbl.table_name, tbl.quoted_name;
+      `
+        });
+        /**
+         * Reduces the SQL results into a Record of {@link DatabaseSchema}
+         * then returns the values as an array.
+         */
+        return Object.values(results.reduce((hash, result) => {
+            const schema = hash[result.schema_name] ||
+                (hash[result.schema_name] = {
+                    name: result.schema_name,
+                    tables: []
+                });
+            schema.tables.push({
+                name: result.table_name,
+                columns: result.columns.map((column) => ({
+                    name: column.column_name,
+                    type: column.data_type,
+                    sqlite_type: toExpressionTypeFromMySQLType(column.data_type).typeFlags,
+                    internal_type: column.data_type,
+                    pg_type: column.data_type
+                }))
+            });
+            return hash;
+        }, {}));
+    }
+    async retriedQuery(options) {
+        const connection = await this.pool.getConnection();
+        return mysql_utils
+            .retriedQuery({
+            connection: connection,
+            query: options.query,
+            params: options.params
+        })
+            .finally(() => connection.release());
+    }
+}
+//# sourceMappingURL=MySQLRouteAPIAdapter.js.map

package/dist/api/MySQLRouteAPIAdapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MySQLRouteAPIAdapter.js","sourceRoot":"","sources":["../../src/api/MySQLRouteAPIAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8B,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAE9E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,aAAa,MAAM,0BAA0B,CAAC;AAE1D,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,KAAK,WAAW,MAAM,yBAAyB,CAAC;AAEvD,OAAO,EAAE,6BAA6B,EAAE,MAAM,2BAA2B,CAAC;AAQ1E,MAAM,OAAO,oBAAoB;IAG/B,YAAsB,MAAsC;QAAtC,WAAM,GAAN,MAAM,CAAgC;QAC1D,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC;IACvD,CAAC;IAED,KAAK,CAAC,QAAQ;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,eAAe;QACnB,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,wBAAwB;QACtB,OAAO;YACL,gFAAgF;YAChF,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;SACpC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,mBAAmB;QACvB,MAAM,IAAI,GAAG;YACX,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE;YAClB,GAAG,EAAE,WAAW,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;SACnF,CAAC;QACF,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,YAAY,CAAC;gBACtB,KAAK,EAAE,oCAAoC;aAC5C,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO;gBACL,GAAG,IAAI;gBACP,SAAS,EAAE,KAAK;gBAChB,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC,IAAI,eAAe,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;aAC3E,CAAC;QACJ,CAAC;QACD,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;QACnD,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC;YACjE,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBAClB,OAAO;oBACL,GAAG,IAAI;oBACP,SAAS,EAAE,IAAI;oBACf,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;iBAC5D,CAAC;YACJ,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO;gBACL,GAAG,IAAI;gBACP,SAAS,EAAE,IAAI;gBACf,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;aACjD,CAAC;QACJ,CAAC;gBAAS,CAAC;YACT,UAAU,CAAC,OAAO,EAAE,CAAC;QACvB,CAAC;QACD,OAAO;YACL,GAAG,IAAI;YACP,SAAS,EAAE,IAAI;YACf,MAAM,EAAE,EAAE;SACX,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,KAAa,EAAE,MAAa;QAC7C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;YAC3B,OAAO,aAAa,CAAC,eAAe,CAAC,kBAAkB,CAAC,MAAM,CAAC;gBAC7D,OAAO,EAAE;oBACP,OAAO,EAAE,EAAE;oBACX,IAAI,EAAE,EAAE;iBACT;gBACD,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,6BAA6B;aACrC,CAAC,CAAC;QACL,CAAC;QACD,IAAI,CAAC;YACH,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAAwB,KAAK,EAAE,MAAM,CAAC,CAAC;YACtF,OAAO,aAAa,CAAC,eAAe,CAAC,kBAAkB,CAAC,MAAM,CAAC;gBAC7D,OAAO,EAAE,IAAI;gBACb,OAAO,EAAE;oBACP,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;oBAClC,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;wBACxB;;;2BAGG;wBACH,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;4BACtB,MAAM,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;4BAC1B,MAAM,QAAQ,GAAG,UAAU,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;4BACpD,IAAI,OAAO,QAAQ,IAAI,QAAQ,EAAE,CAAC;gCAChC,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;4BACvB,CAAC;iCAAM,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;gCACjC,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC;4BAC7B,CAAC;iCAAM,IAAI,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;gCAC5C,OAAO,QAAQ,CAAC;4BAClB,CAAC;iCAAM,CAAC;gCACN,OAAO,IAAI,CAAC;4BACd,CAAC;wBACH,CAAC,CAAC,CAAC;oBACL,CAAC,CAAC;iBACH;aACF,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,aAAa,CAAC,eAAe,CAAC,kBAAkB,CAAC,MAAM,CAAC;gBAC7D,OAAO,EAAE;oBACP,OAAO,EAAE,EAAE;oBACX,IAAI,EAAE,EAAE;iBACT;gBACD,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,CAAC,CAAC,OAAO;aACjB,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,KAAK,CAAC,kBAAkB,CACtB,aAAwC,EACxC,YAAqC;QAErC,IAAI,MAAM,GAAwB,EAAE,CAAC;QAErC,KAAK,IAAI,YAAY,IAAI,aAAa,EAAE,CAAC;YACvC,MAAM,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC;YACnC,IAAI,aAAa,GAAsB;gBACrC,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,YAAY,CAAC,YAAY;gBAClC,QAAQ,EAAE,YAAY,CAAC,UAAU;aAClC,CAAC;YACF,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAE3B,IAAI,YAAY,CAAC,UAAU,EAAE,CAAC;gBAC5B,aAAa,CAAC,MAAM,GAAG,EAAE,CAAC;gBAC1B,MAAM,MAAM,GAAG,YAAY,CAAC,WAAW,CAAC;gBAExC,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CACrC;;;;;;kCAMwB,EACxB,CAAC,MAAM,EAAE,YAAY,CAAC,YAAY,CAAC,CACpC,CAAC;gBAEF,KAAK,IAAI,GAAG,IAAI,OAAO,EAAE,CAAC;oBACxB,MAAM,IAAI,GAAG,GAAG,CAAC,UAAoB,CAAC;oBAEtC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;wBAC7B,SAAS;oBACX,CAAC;oBAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;oBAC/E,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACrC,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CACrC;;;;;;+BAMqB,EACrB,CAAC,YAAY,CAAC,MAAM,EAAE,YAAY,CAAC,YAAY,CAAC,CACjD,CAAC;gBAEF,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;oBACxB,kBAAkB;oBAClB,aAAa,CAAC,KAAK,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,YAAY,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;gBACpG,CAAC;qBAAM,CAAC;oBACN,MAAM,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;oBACvB,aAAa,CAAC,KAAK,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,GAAG,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;gBACjG,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAES,KAAK,CAAC,iBAAiB,CAC/B,YAAqC,EACrC,SAAiB,EACjB,SAAkC;QAElC,MAAM,EAAE,MAAM,EAAE,GAAG,YAAY,CAAC;QAEhC,IAAI,eAAe,GAAmD,IAAI,CAAC;QAC3E,IAAI,cAAc,GAA0C,IAAI,CAAC;QACjE,IAAI,UAAU,GAAgC,IAAI,CAAC;QACnD,IAAI,CAAC;YACH,UAAU,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YAC7C,eAAe,GAAG,MAAM,MAAM,CAAC,6BAA6B,CAAC;gBAC3D,UAAU,EAAE,UAAU;gBACtB,MAAM;gBACN,UAAU,EAAE,SAAS;aACtB,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,EAAE,EAAE,CAAC;YACZ,cAAc,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC;QAC3D,CAAC;gBAAS,CAAC;YACT,UAAU,EAAE,OAAO,EAAE,CAAC;QACxB,CAAC;QAED,MAAM,SAAS,GAAG,eAAe,EAAE,OAAO,IAAI,EAAE,CAAC;QACjD,MAAM,WAAW,GAAG,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;QAC/G,MAAM,QAAQ,GAAG,SAAS,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QACvD,MAAM,cAAc,GAAG,SAAS,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;QAEnE,IAAI,SAAS,CAAC,MAAM,IAAI,CAAC,IAAI,cAAc,IAAI,IAAI,EAAE,CAAC;YACpD,IAAI,OAAO,GAAG,+BAA+B,WAAW,CAAC,aAAa,uBAAuB,eAAe,EAAE,QAAQ,GAAG,CAAC;YAC1H,IAAI,eAAe,EAAE,QAAQ,IAAI,SAAS,EAAE,CAAC;gBAC3C,OAAO,IAAI,wCAAwC,CAAC;YACtD,CAAC;YACD,cAAc,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;QAC/C,CAAC;QAED,IAAI,WAAW,GAA0C,IAAI,CAAC;QAC9D,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,YAAY,CAAC;gBACtB,KAAK,EAAE,iBAAiB,WAAW,CAAC,KAAK,UAAU;aACpD,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,WAAW,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;QACvD,CAAC;QAED,OAAO;YACL,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS;YACxE,cAAc,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;YAC5C,YAAY,EAAE,QAAQ;YACtB,iBAAiB,EAAE,cAAc;YACjC,MAAM,EAAE,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,IAAI,IAAI,CAAqC;SAC3G,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,OAAkC;QACxD,MAAM,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;QAClC,MAAM,cAAc,GAAG,MAAM,aAAa,CAAC,aAAa,EAAE,CAAC;QAE3D,MAAM,OAAO,GAAG,cAAc,CAAC,GAAG;YAChC,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,cAAc,CAAC,GAAG,CAAC;YAC1D,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC;QAE/B,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;QACnD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QACvD,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QACvD,UAAU,CAAC,OAAO,EAAE,CAAC;QACrB,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,CAAC;QAED,OAAO,GAAG,CAAC;IACb,CAAC;IAED,KAAK,CAAC,kBAAkB;QACtB,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;QACnD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QACzD,UAAU,CAAC,OAAO,EAAE,CAAC;QACrB,OAAO,MAAM,CAAC,UAAU,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,mBAAmB;QACvB,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC;YACxC,KAAK,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCN;SACF,CAAC,CAAC;QAEH;;;WAGG;QAEH,OAAO,MAAM,CAAC,MAAM,CACjB,OAA0B,CAAC,MAAM,CAAC,CAAC,IAAkD,EAAE,MAAM,EAAE,EAAE;YAChG,MAAM,MAAM,GACV,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;gBACxB,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG;oBAC1B,IAAI,EAAE,MAAM,CAAC,WAAW;oBACxB,MAAM,EAAE,EAAE;iBACX,CAAC,CAAC;YAEL,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;gBACjB,IAAI,EAAE,MAAM,CAAC,UAAU;gBACvB,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;oBACvC,IAAI,EAAE,MAAM,CAAC,WAAW;oBACxB,IAAI,EAAE,MAAM,CAAC,SAAS;oBACtB,WAAW,EAAE,6BAA6B,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS;oBACtE,aAAa,EAAE,MAAM,CAAC,SAAS;oBAC/B,OAAO,EAAE,MAAM,CAAC,SAAS;iBAC1B,CAAC,CAAC;aACJ,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC;QACd,CAAC,EAAE,EAAE,CAAC,CACP,CAAC;IACJ,CAAC;IAES,KAAK,CAAC,YAAY,CAAC,OAA0C;QACrE,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;QAEnD,OAAO,WAAW;aACf,YAAY,CAAC;YACZ,UAAU,EAAE,UAAU;YACtB,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC;aACD,OAAO,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;IACzC,CAAC;CACF"}

package/dist/common/ReplicatedGTID.d.ts

@@ -0,0 +1,59 @@
+import mysql from 'mysql2/promise';
+export type BinLogPosition = {
+    filename: string;
+    offset: number;
+};
+export type ReplicatedGTIDSpecification = {
+    raw_gtid: string;
+    /**
+     * The (end) position in a BinLog file where this transaction has been replicated in.
+     */
+    position: BinLogPosition;
+};
+export type BinLogGTIDFormat = {
+    server_id: Buffer;
+    transaction_range: number;
+};
+export type BinLogGTIDEvent = {
+    raw_gtid: BinLogGTIDFormat;
+    position: BinLogPosition;
+};
+/**
+ * A wrapper around the MySQL GTID value.
+ * This adds and tracks additional metadata such as the BinLog filename
+ * and position where this GTID could be located.
+ */
+export declare class ReplicatedGTID {
+    protected options: ReplicatedGTIDSpecification;
+    static fromSerialized(comparable: string): ReplicatedGTID;
+    private static deserialize;
+    static fromBinLogEvent(event: BinLogGTIDEvent): ReplicatedGTID;
+    /**
+     * Special case for the zero GTID which means no transactions have been executed.
+     */
+    static ZERO: ReplicatedGTID;
+    constructor(options: ReplicatedGTIDSpecification);
+    /**
+     * Get the BinLog position of this replicated GTID event
+     */
+    get position(): BinLogPosition;
+    /**
+     * Get the raw Global Transaction ID. This of the format `server_id:transaction_ranges`
+     */
+    get raw(): string;
+    get serverId(): string;
+    /**
+     * Transforms a GTID into a comparable string format, ensuring lexicographical
+     * order aligns with the GTID's relative age. This assumes that all GTIDs
+     * have the same server ID.
+     *
+     * @returns A comparable string in the format
+     *   `padded_end_transaction|raw_gtid|binlog_filename|binlog_position`
+     */
+    get comparable(): string;
+    toString(): string;
+    /**
+     * Calculates the distance in bytes from this GTID to the provided argument.
+     */
+    distanceTo(connection: mysql.Connection, to: ReplicatedGTID): Promise<number | null>;
+}