hysteria-orm 10.3.0 → 10.3.2

package/lib/index.d.cts

@@ -6,7 +6,7 @@ import { Collection as Collection$1 } from 'mongodb';
 import * as sqlite3 from 'sqlite3';
 import { RunResult } from 'sqlite3';
 import * as pg from 'pg';
-import { ClientConfig, PoolClient, QueryResult as QueryResult$1 } from 'pg';
+import { PoolConfig, PoolClient, QueryResult as QueryResult$1 } from 'pg';
 import * as mysql2_promise from 'mysql2/promise';
 import { PoolOptions, PoolConnection, QueryResult } from 'mysql2/promise';
 import { RedisOptions, Redis } from 'ioredis';
@@ -131,12 +131,12 @@ type MongoClientImport = typeof mongodb;
 type MssqlImport = typeof mssql;
 type OracleDBCreateConnectionOptions = PoolAttributes;
 type MysqlCreateConnectionOptions = PoolOptions;
-type PgClientOptions = ClientConfig;
+type PgPoolOptions = PoolConfig;
 type MssqlConnectionOptions = Omit<config, "options"> & {
     options?: Omit<NonNullable<config["options"]>, "abortTransactionOnError" | "enableImplicitTransactions">;
 };
 type MongoConnectionOptions = NonNullable<ConstructorParameters<MongoClientImport["MongoClient"]>[1]>;
-type DriverSpecificOptions<T extends DataSourceType> = T extends "mongo" ? MongoConnectionOptions : T extends "cockroachdb" | "postgres" ? PgClientOptions : T extends "redis" ? RedisOptions : T extends "mysql" | "mariadb" ? MysqlCreateConnectionOptions : T extends "mssql" ? MssqlConnectionOptions : T extends "oracledb" ? OracleDBCreateConnectionOptions : never;
+type DriverSpecificOptions<T extends DataSourceType> = T extends "mongo" ? MongoConnectionOptions : T extends "cockroachdb" | "postgres" ? PgPoolOptions : T extends "redis" ? RedisOptions : T extends "mysql" | "mariadb" ? MysqlCreateConnectionOptions : T extends "mssql" ? MssqlConnectionOptions : T extends "oracledb" ? OracleDBCreateConnectionOptions : never;
 
 type MongoCollectionKey<T> = T extends Collection ? T : never;
 type BaseModelMethodOptions$1 = {
@@ -1164,6 +1164,21 @@ type SqlDataSourceInput<D extends SqlDataSourceType = SqlDataSourceType, T exten
      * @warning For usage with types, you must have driver types installed if the driver handles types in a type package like e.g. `@types/pg`
      */
     driverOptions?: SqlDriverSpecificOptions<D>;
+    /**
+     * @description The replication configuration for the sql data source, it's used to configure the replication for the sql data source
+     */
+    replication?: {
+        /**
+         * @description The slaves data sources to use for the sql data source, slaves are automatically used for read operations unless specified otherwise
+         */
+        slaves?: Omit<UseConnectionInput<D, T, C>, "slaves" | "models" | "cacheStrategy" | "adminJs" | "logs" | "queryFormatOptions" | "migrationsPath">[];
+        /**
+         * @description The algorithm to use for selecting the slave for read operations
+         * @default "roundRobin" - Distributes requests evenly across all slaves in sequence
+         * @option "random" - Randomly selects a slave for each request
+         */
+        slaveAlgorithm?: SlaveAlgorithm;
+    };
 } & Omit<MapSqlDataSourceTypeToInput<D>, "type">;
 /**
  * @description Maps a SqlDataSourceType to its corresponding non-nullable input interface
@@ -1202,6 +1217,16 @@ type GetConnectionReturnType<T = SqlDataSourceType> = T extends "mysql" ? PoolCo
 /** Only accepts formats `string` e `string as string` */
 type NoSpace<S extends string> = S extends `${infer _} ${infer _}` ? never : S;
 type TableFormat<S extends string> = NoSpace<S> | (S extends `${infer L} as ${infer R}` ? `${NoSpace<L>} as ${NoSpace<R>}` : never);
+type ReplicationType = "master" | "slave";
+/**
+ * @description Algorithm for selecting a slave database for read operations
+ * @option "roundRobin" - Distributes requests evenly across all slaves in sequence
+ * @option "random" - Randomly selects a slave for each request
+ */
+type SlaveAlgorithm = "roundRobin" | "random";
+type RawQueryOptions = {
+    replicationMode?: ReplicationType;
+};
 
 type AstParserType = {
     sql: string;
@@ -3411,10 +3436,15 @@ declare class ModelManager<T extends Model> {
     protected modelInstance: T;
     protected astParser: AstParser;
     protected interpreterUtils: InterpreterUtils;
+    protected replicationMode: "master" | "slave" | null;
     /**
      * @description Constructor for ModelManager class.
      */
     constructor(model: typeof Model, sqlDataSource: SqlDataSource);
+    /**
+     * @description Sets the replication mode for queries created by this model manager
+     */
+    setReplicationMode(mode: "master" | "slave"): this;
     /**
      * @description Finds all records that match the input
      */
@@ -3631,6 +3661,21 @@ declare class SqlDataSource<D extends SqlDataSourceType = SqlDataSourceType, T e
     private sqlType;
     private _models;
     private ownsPool;
+    /**
+     * @description The slaves data sources to use for the sql data source, slaves are automatically used for read operations unless specified otherwise
+     */
+    slaves: SqlDataSource<D, T, C>[];
+    /**
+     * @description The algorithm to use for selecting the slave for read operations
+     * @default "roundRobin" - Distributes requests evenly across all slaves in sequence
+     * @option "random" - Randomly selects a slave for each request
+     */
+    slaveAlgorithm: SlaveAlgorithm;
+    /**
+     * @description The current index for round-robin slave selection
+     * @private
+     */
+    private roundRobinIndex;
     /**
      * @description The pool of connections for the database
      */
@@ -3683,7 +3728,7 @@ declare class SqlDataSource<D extends SqlDataSourceType = SqlDataSourceType, T e
      * const user = await User.query({ connection: secondaryDb }).many();
      * ```
      */
-    static connectToSecondarySource<U extends SqlDataSourceType, M extends Record<string, SqlDataSourceModel> = {}, K extends CacheKeys = {}>(input: SqlDataSourceInput<U, M, K>, cb?: (sqlDataSource: SqlDataSource<U, M, K>) => Promise<void> | void): Promise<SqlDataSource<U, M, K>>;
+    static connectToSecondarySource<U extends SqlDataSourceType, M extends Record<string, SqlDataSourceModel> = {}, K extends CacheKeys = {}>(input: Omit<SqlDataSourceInput<U, M, K>, "slaves">, cb?: (sqlDataSource: SqlDataSource<U, M, K>) => Promise<void> | void): Promise<SqlDataSource<U, M, K>>;
     /**
      * @description Creates a temporary connection that is automatically closed after the callback is executed
      * @example
@@ -3748,7 +3793,7 @@ declare class SqlDataSource<D extends SqlDataSourceType = SqlDataSourceType, T e
      */
     constructor(input?: SqlDataSourceInput<D, T, C>);
     /**
-     * @description Establishes the database connection and sets this instance as the primary connection
+     * @description Establishes the database connection and sets this instance as the primary connection, it also connects to the slaves if any are configured
      * @throws {HysteriaError} If the connection is already established, use `SqlDataSource.useConnection` or `SqlDataSource.connectToSecondarySource` for auxiliary connections
      * @example
      * ```ts
@@ -3769,6 +3814,11 @@ declare class SqlDataSource<D extends SqlDataSourceType = SqlDataSourceType, T e
      * @description Returns the models configured on this SqlDataSource instance
      */
     get models(): T;
+    /**
+     * @description Selects a slave from the pool using the configured algorithm
+     * @returns A slave SqlDataSource instance or null if no slaves are available
+     */
+    getSlave(): SqlDataSource<D, T, C> | null;
     /**
      * @description Uses the cache adapter to get a value from the cache
      * @param key The key to get the value from
@@ -3864,6 +3914,7 @@ declare class SqlDataSource<D extends SqlDataSourceType = SqlDataSourceType, T e
     /**
      * @description Closes the current connection
      * @description If there is an active global transaction, it will be rolled back
+     * @description Also disconnects all slave connections if any are configured
      */
     closeConnection(): Promise<void>;
     /**
@@ -3885,7 +3936,7 @@ declare class SqlDataSource<D extends SqlDataSourceType = SqlDataSourceType, T e
     /**
      * @description Executes a raw query on the database and returns the raw driver result
      */
-    rawQuery<R = RawQueryResponseType<D>>(query: string, params?: any[]): Promise<R>;
+    rawQuery<R = RawQueryResponseType<D>>(query: string, params?: any[], options?: RawQueryOptions): Promise<R>;
     /**
      * @description Adds a raw statement to an operation like where or update
      * @example
@@ -3983,6 +4034,13 @@ type BaseModelMethodOptions = {
      * @description Whether to ignore the hooks for the model
      */
     ignoreHooks?: boolean;
+    /**
+     * @description The replication mode to use for the model
+     * @description If not specified, read operations will use slave (if available) else master, and write operations will always use master
+     * @description If set to "master", all operations will use master
+     * @description If set to "slave", read operations will use slave and write operations will use master
+     */
+    replicationMode?: ReplicationType;
 };
 /**
  * @description Options that can be provided to a raw sql operation (like the raw QueryBuilder)
@@ -4020,6 +4078,7 @@ declare class QueryBuilder<T extends Model = any> extends JsonQueryBuilder<T> {
     protected updateNode: UpdateNode | null;
     protected deleteNode: DeleteNode | null;
     protected truncateNode: TruncateNode | null;
+    protected replicationMode: ReplicationType | null;
     /**
      * @description Performance methods that return the time that took to execute the query with the result
      */
@@ -4086,6 +4145,14 @@ declare class QueryBuilder<T extends Model = any> extends JsonQueryBuilder<T> {
         }>;
     };
     constructor(model: typeof Model, sqlDataSource?: SqlDataSource);
+    /**
+     * @description Sets the replication mode for the query builder
+     * @param replicationMode - The replication mode to use for the query builder
+     * @description If not specified, read operations will use slave (if available) else master, and write operations will always use master
+     * @description If set to "master", all operations will use master
+     * @description If set to "slave", read operations will use slave and write operations will use master
+     */
+    setReplicationMode(replicationMode: ReplicationType): this;
     /**
      * @description Executes the query and returns true if the query returns at least one result, false otherwise.
      */
@@ -4388,6 +4455,7 @@ declare class QueryBuilder<T extends Model = any> extends JsonQueryBuilder<T> {
      * @description Executes pagination queries, serializing them for MSSQL transactions
      */
     protected executePaginateQueries<M, C>(modelsQuery: () => Promise<M>, countQuery: () => Promise<C>): Promise<[M, C]>;
+    protected getSqlDataSource(mode: "read" | "write"): Promise<SqlDataSource>;
 }
 
 type UnionCallBack<T extends Model> = (queryBuilder: QueryBuilder<T>) => QueryBuilder<T>;
@@ -5866,4 +5934,4 @@ declare const generateOpenApiModelWithMetadata: <T extends new () => Model>(mode
     $id?: string;
 }>;
 
-export { type AdminJsActionOptions, type AdminJsAssets, type AdminJsBranding, type AdminJsInstance, type AdminJsLocale, type AdminJsOptions, type AdminJsPage, type AdminJsPropertyOptions, type AdminJsResourceOptions, type AdminJsSettings, type AnnotatedModel, type AsymmetricEncryptionOptions, AutogeneratedModel, type BaseModelMethodOptions, type BaseModelRelationType, type CacheAdapter, type CacheKeys, ClientMigrator, Collection, type ColumnDataTypeOption, type ColumnDataTypeOptionSimple, type ColumnDataTypeOptionWithBinary, type ColumnDataTypeOptionWithDatePrecision, type ColumnDataTypeOptionWithEnum, type ColumnDataTypeOptionWithLength, type ColumnDataTypeOptionWithPrecision, type ColumnDataTypeOptionWithScaleAndPrecision, type ColumnDataTypeOptionWithText, type ColumnOptions, type ColumnType, type CommonDataSourceInput, type CommonSqlMethodReturnType, type ConnectionPolicies, type DataSourceInput, type DataSourceType, type DateColumnOptions, DryModelQueryBuilder, DryQueryBuilder, type FetchHooks, type GetConnectionReturnType, HysteriaError, InMemoryAdapter, type IndexType, type LazyRelationType, type ManyOptions, type ManyToManyOptions, type ManyToManyStringOptions, Migration, Model, type ModelInstanceType, ModelQueryBuilder, type ModelWithoutRelations, MongoDataSource, type MongoDataSourceInput$1 as MongoDataSourceInput, type MssqlConnectionInstance, type MssqlDataSourceInput, type MssqlPoolInstance, type MysqlConnectionInstance, type MysqlSqlDataSourceInput, type NotNullableMysqlSqlDataSourceInput, type NotNullableOracleDBDataSourceInput, type NotNullableOracleMssqlDataSourceInput, type NotNullablePostgresSqlDataSourceInput, type NotNullableSqliteDataSourceInput, type NumberModelKey, type OneOptions, type OracleDBDataSourceInput, type OracleDBPoolInstance, type PgPoolClientInstance, type PostgresSqlDataSourceInput, QueryBuilder, type RawModelOptions, RawNode, RedisCacheAdapter, type RedisFetchable, type RedisStorable, type RelatedInstance, type RelationQueryBuilderType, type SqlCloneOptions, SqlDataSource, type SqlDataSourceInput, type SqlDataSourceModel, type SqlDataSourceType, type SqlDriverSpecificOptions, type SqlPoolType, type Sqlite3ConnectionOptions, type SqliteConnectionInstance, type SqliteDataSourceInput, type StartTransactionOptions, type SymmetricEncryptionOptions, type TableFormat, type ThroughModel, TimestampedModel, Transaction, type TransactionExecutionOptions, type UniqueType, type UseCacheReturnType, type UseConnectionInput, UserMixin, UuidModel, belongsTo, column, createModelFactory, defineMigrator, generateOpenApiModel, generateOpenApiModelSchema, generateOpenApiModelWithMetadata, getCollectionProperties, getIndexes, getModelColumns, type getPoolReturnType, getPrimaryKey, getRelations, getRelationsMetadata, getUniques, hasMany, hasOne, index, HysteriaLogger as logger, manyToMany, property, RedisDataSource as redis, unique, view, withPerformance };
+export { type AdminJsActionOptions, type AdminJsAssets, type AdminJsBranding, type AdminJsInstance, type AdminJsLocale, type AdminJsOptions, type AdminJsPage, type AdminJsPropertyOptions, type AdminJsResourceOptions, type AdminJsSettings, type AnnotatedModel, type AsymmetricEncryptionOptions, AutogeneratedModel, type BaseModelMethodOptions, type BaseModelRelationType, type CacheAdapter, type CacheKeys, ClientMigrator, Collection, type ColumnDataTypeOption, type ColumnDataTypeOptionSimple, type ColumnDataTypeOptionWithBinary, type ColumnDataTypeOptionWithDatePrecision, type ColumnDataTypeOptionWithEnum, type ColumnDataTypeOptionWithLength, type ColumnDataTypeOptionWithPrecision, type ColumnDataTypeOptionWithScaleAndPrecision, type ColumnDataTypeOptionWithText, type ColumnOptions, type ColumnType, type CommonDataSourceInput, type CommonSqlMethodReturnType, type ConnectionPolicies, type DataSourceInput, type DataSourceType, type DateColumnOptions, DryModelQueryBuilder, DryQueryBuilder, type FetchHooks, type GetConnectionReturnType, HysteriaError, InMemoryAdapter, type IndexType, type LazyRelationType, type ManyOptions, type ManyToManyOptions, type ManyToManyStringOptions, Migration, Model, type ModelInstanceType, ModelQueryBuilder, type ModelWithoutRelations, MongoDataSource, type MongoDataSourceInput$1 as MongoDataSourceInput, type MssqlConnectionInstance, type MssqlDataSourceInput, type MssqlPoolInstance, type MysqlConnectionInstance, type MysqlSqlDataSourceInput, type NotNullableMysqlSqlDataSourceInput, type NotNullableOracleDBDataSourceInput, type NotNullableOracleMssqlDataSourceInput, type NotNullablePostgresSqlDataSourceInput, type NotNullableSqliteDataSourceInput, type NumberModelKey, type OneOptions, type OracleDBDataSourceInput, type OracleDBPoolInstance, type PgPoolClientInstance, type PostgresSqlDataSourceInput, QueryBuilder, type RawModelOptions, RawNode, type RawQueryOptions, RedisCacheAdapter, type RedisFetchable, type RedisStorable, type RelatedInstance, type RelationQueryBuilderType, type ReplicationType, type SlaveAlgorithm, type SqlCloneOptions, SqlDataSource, type SqlDataSourceInput, type SqlDataSourceModel, type SqlDataSourceType, type SqlDriverSpecificOptions, type SqlPoolType, type Sqlite3ConnectionOptions, type SqliteConnectionInstance, type SqliteDataSourceInput, type StartTransactionOptions, type SymmetricEncryptionOptions, type TableFormat, type ThroughModel, TimestampedModel, Transaction, type TransactionExecutionOptions, type UniqueType, type UseCacheReturnType, type UseConnectionInput, UserMixin, UuidModel, belongsTo, column, createModelFactory, defineMigrator, generateOpenApiModel, generateOpenApiModelSchema, generateOpenApiModelWithMetadata, getCollectionProperties, getIndexes, getModelColumns, type getPoolReturnType, getPrimaryKey, getRelations, getRelationsMetadata, getUniques, hasMany, hasOne, index, HysteriaLogger as logger, manyToMany, property, RedisDataSource as redis, unique, view, withPerformance };

package/lib/index.d.ts

@@ -6,7 +6,7 @@ import { Collection as Collection$1 } from 'mongodb';
 import * as sqlite3 from 'sqlite3';
 import { RunResult } from 'sqlite3';
 import * as pg from 'pg';
-import { ClientConfig, PoolClient, QueryResult as QueryResult$1 } from 'pg';
+import { PoolConfig, PoolClient, QueryResult as QueryResult$1 } from 'pg';
 import * as mysql2_promise from 'mysql2/promise';
 import { PoolOptions, PoolConnection, QueryResult } from 'mysql2/promise';
 import { RedisOptions, Redis } from 'ioredis';
@@ -131,12 +131,12 @@ type MongoClientImport = typeof mongodb;
 type MssqlImport = typeof mssql;
 type OracleDBCreateConnectionOptions = PoolAttributes;
 type MysqlCreateConnectionOptions = PoolOptions;
-type PgClientOptions = ClientConfig;
+type PgPoolOptions = PoolConfig;
 type MssqlConnectionOptions = Omit<config, "options"> & {
     options?: Omit<NonNullable<config["options"]>, "abortTransactionOnError" | "enableImplicitTransactions">;
 };
 type MongoConnectionOptions = NonNullable<ConstructorParameters<MongoClientImport["MongoClient"]>[1]>;
-type DriverSpecificOptions<T extends DataSourceType> = T extends "mongo" ? MongoConnectionOptions : T extends "cockroachdb" | "postgres" ? PgClientOptions : T extends "redis" ? RedisOptions : T extends "mysql" | "mariadb" ? MysqlCreateConnectionOptions : T extends "mssql" ? MssqlConnectionOptions : T extends "oracledb" ? OracleDBCreateConnectionOptions : never;
+type DriverSpecificOptions<T extends DataSourceType> = T extends "mongo" ? MongoConnectionOptions : T extends "cockroachdb" | "postgres" ? PgPoolOptions : T extends "redis" ? RedisOptions : T extends "mysql" | "mariadb" ? MysqlCreateConnectionOptions : T extends "mssql" ? MssqlConnectionOptions : T extends "oracledb" ? OracleDBCreateConnectionOptions : never;
 
 type MongoCollectionKey<T> = T extends Collection ? T : never;
 type BaseModelMethodOptions$1 = {
@@ -1164,6 +1164,21 @@ type SqlDataSourceInput<D extends SqlDataSourceType = SqlDataSourceType, T exten
      * @warning For usage with types, you must have driver types installed if the driver handles types in a type package like e.g. `@types/pg`
      */
     driverOptions?: SqlDriverSpecificOptions<D>;
+    /**
+     * @description The replication configuration for the sql data source, it's used to configure the replication for the sql data source
+     */
+    replication?: {
+        /**
+         * @description The slaves data sources to use for the sql data source, slaves are automatically used for read operations unless specified otherwise
+         */
+        slaves?: Omit<UseConnectionInput<D, T, C>, "slaves" | "models" | "cacheStrategy" | "adminJs" | "logs" | "queryFormatOptions" | "migrationsPath">[];
+        /**
+         * @description The algorithm to use for selecting the slave for read operations
+         * @default "roundRobin" - Distributes requests evenly across all slaves in sequence
+         * @option "random" - Randomly selects a slave for each request
+         */
+        slaveAlgorithm?: SlaveAlgorithm;
+    };
 } & Omit<MapSqlDataSourceTypeToInput<D>, "type">;
 /**
  * @description Maps a SqlDataSourceType to its corresponding non-nullable input interface
@@ -1202,6 +1217,16 @@ type GetConnectionReturnType<T = SqlDataSourceType> = T extends "mysql" ? PoolCo
 /** Only accepts formats `string` e `string as string` */
 type NoSpace<S extends string> = S extends `${infer _} ${infer _}` ? never : S;
 type TableFormat<S extends string> = NoSpace<S> | (S extends `${infer L} as ${infer R}` ? `${NoSpace<L>} as ${NoSpace<R>}` : never);
+type ReplicationType = "master" | "slave";
+/**
+ * @description Algorithm for selecting a slave database for read operations
+ * @option "roundRobin" - Distributes requests evenly across all slaves in sequence
+ * @option "random" - Randomly selects a slave for each request
+ */
+type SlaveAlgorithm = "roundRobin" | "random";
+type RawQueryOptions = {
+    replicationMode?: ReplicationType;
+};
 
 type AstParserType = {
     sql: string;
@@ -3411,10 +3436,15 @@ declare class ModelManager<T extends Model> {
     protected modelInstance: T;
     protected astParser: AstParser;
     protected interpreterUtils: InterpreterUtils;
+    protected replicationMode: "master" | "slave" | null;
     /**
      * @description Constructor for ModelManager class.
      */
     constructor(model: typeof Model, sqlDataSource: SqlDataSource);
+    /**
+     * @description Sets the replication mode for queries created by this model manager
+     */
+    setReplicationMode(mode: "master" | "slave"): this;
     /**
      * @description Finds all records that match the input
      */
@@ -3631,6 +3661,21 @@ declare class SqlDataSource<D extends SqlDataSourceType = SqlDataSourceType, T e
     private sqlType;
     private _models;
     private ownsPool;
+    /**
+     * @description The slaves data sources to use for the sql data source, slaves are automatically used for read operations unless specified otherwise
+     */
+    slaves: SqlDataSource<D, T, C>[];
+    /**
+     * @description The algorithm to use for selecting the slave for read operations
+     * @default "roundRobin" - Distributes requests evenly across all slaves in sequence
+     * @option "random" - Randomly selects a slave for each request
+     */
+    slaveAlgorithm: SlaveAlgorithm;
+    /**
+     * @description The current index for round-robin slave selection
+     * @private
+     */
+    private roundRobinIndex;
     /**
      * @description The pool of connections for the database
      */
@@ -3683,7 +3728,7 @@ declare class SqlDataSource<D extends SqlDataSourceType = SqlDataSourceType, T e
      * const user = await User.query({ connection: secondaryDb }).many();
      * ```
      */
-    static connectToSecondarySource<U extends SqlDataSourceType, M extends Record<string, SqlDataSourceModel> = {}, K extends CacheKeys = {}>(input: SqlDataSourceInput<U, M, K>, cb?: (sqlDataSource: SqlDataSource<U, M, K>) => Promise<void> | void): Promise<SqlDataSource<U, M, K>>;
+    static connectToSecondarySource<U extends SqlDataSourceType, M extends Record<string, SqlDataSourceModel> = {}, K extends CacheKeys = {}>(input: Omit<SqlDataSourceInput<U, M, K>, "slaves">, cb?: (sqlDataSource: SqlDataSource<U, M, K>) => Promise<void> | void): Promise<SqlDataSource<U, M, K>>;
     /**
      * @description Creates a temporary connection that is automatically closed after the callback is executed
      * @example
@@ -3748,7 +3793,7 @@ declare class SqlDataSource<D extends SqlDataSourceType = SqlDataSourceType, T e
      */
     constructor(input?: SqlDataSourceInput<D, T, C>);
     /**
-     * @description Establishes the database connection and sets this instance as the primary connection
+     * @description Establishes the database connection and sets this instance as the primary connection, it also connects to the slaves if any are configured
      * @throws {HysteriaError} If the connection is already established, use `SqlDataSource.useConnection` or `SqlDataSource.connectToSecondarySource` for auxiliary connections
      * @example
      * ```ts
@@ -3769,6 +3814,11 @@ declare class SqlDataSource<D extends SqlDataSourceType = SqlDataSourceType, T e
      * @description Returns the models configured on this SqlDataSource instance
      */
     get models(): T;
+    /**
+     * @description Selects a slave from the pool using the configured algorithm
+     * @returns A slave SqlDataSource instance or null if no slaves are available
+     */
+    getSlave(): SqlDataSource<D, T, C> | null;
     /**
      * @description Uses the cache adapter to get a value from the cache
      * @param key The key to get the value from
@@ -3864,6 +3914,7 @@ declare class SqlDataSource<D extends SqlDataSourceType = SqlDataSourceType, T e
     /**
      * @description Closes the current connection
      * @description If there is an active global transaction, it will be rolled back
+     * @description Also disconnects all slave connections if any are configured
      */
     closeConnection(): Promise<void>;
     /**
@@ -3885,7 +3936,7 @@ declare class SqlDataSource<D extends SqlDataSourceType = SqlDataSourceType, T e
     /**
      * @description Executes a raw query on the database and returns the raw driver result
      */
-    rawQuery<R = RawQueryResponseType<D>>(query: string, params?: any[]): Promise<R>;
+    rawQuery<R = RawQueryResponseType<D>>(query: string, params?: any[], options?: RawQueryOptions): Promise<R>;
     /**
      * @description Adds a raw statement to an operation like where or update
      * @example
@@ -3983,6 +4034,13 @@ type BaseModelMethodOptions = {
      * @description Whether to ignore the hooks for the model
      */
     ignoreHooks?: boolean;
+    /**
+     * @description The replication mode to use for the model
+     * @description If not specified, read operations will use slave (if available) else master, and write operations will always use master
+     * @description If set to "master", all operations will use master
+     * @description If set to "slave", read operations will use slave and write operations will use master
+     */
+    replicationMode?: ReplicationType;
 };
 /**
  * @description Options that can be provided to a raw sql operation (like the raw QueryBuilder)
@@ -4020,6 +4078,7 @@ declare class QueryBuilder<T extends Model = any> extends JsonQueryBuilder<T> {
     protected updateNode: UpdateNode | null;
     protected deleteNode: DeleteNode | null;
     protected truncateNode: TruncateNode | null;
+    protected replicationMode: ReplicationType | null;
     /**
      * @description Performance methods that return the time that took to execute the query with the result
      */
@@ -4086,6 +4145,14 @@ declare class QueryBuilder<T extends Model = any> extends JsonQueryBuilder<T> {
         }>;
     };
     constructor(model: typeof Model, sqlDataSource?: SqlDataSource);
+    /**
+     * @description Sets the replication mode for the query builder
+     * @param replicationMode - The replication mode to use for the query builder
+     * @description If not specified, read operations will use slave (if available) else master, and write operations will always use master
+     * @description If set to "master", all operations will use master
+     * @description If set to "slave", read operations will use slave and write operations will use master
+     */
+    setReplicationMode(replicationMode: ReplicationType): this;
     /**
      * @description Executes the query and returns true if the query returns at least one result, false otherwise.
      */
@@ -4388,6 +4455,7 @@ declare class QueryBuilder<T extends Model = any> extends JsonQueryBuilder<T> {
      * @description Executes pagination queries, serializing them for MSSQL transactions
      */
     protected executePaginateQueries<M, C>(modelsQuery: () => Promise<M>, countQuery: () => Promise<C>): Promise<[M, C]>;
+    protected getSqlDataSource(mode: "read" | "write"): Promise<SqlDataSource>;
 }
 
 type UnionCallBack<T extends Model> = (queryBuilder: QueryBuilder<T>) => QueryBuilder<T>;
@@ -5866,4 +5934,4 @@ declare const generateOpenApiModelWithMetadata: <T extends new () => Model>(mode
     $id?: string;
 }>;
 
-export { type AdminJsActionOptions, type AdminJsAssets, type AdminJsBranding, type AdminJsInstance, type AdminJsLocale, type AdminJsOptions, type AdminJsPage, type AdminJsPropertyOptions, type AdminJsResourceOptions, type AdminJsSettings, type AnnotatedModel, type AsymmetricEncryptionOptions, AutogeneratedModel, type BaseModelMethodOptions, type BaseModelRelationType, type CacheAdapter, type CacheKeys, ClientMigrator, Collection, type ColumnDataTypeOption, type ColumnDataTypeOptionSimple, type ColumnDataTypeOptionWithBinary, type ColumnDataTypeOptionWithDatePrecision, type ColumnDataTypeOptionWithEnum, type ColumnDataTypeOptionWithLength, type ColumnDataTypeOptionWithPrecision, type ColumnDataTypeOptionWithScaleAndPrecision, type ColumnDataTypeOptionWithText, type ColumnOptions, type ColumnType, type CommonDataSourceInput, type CommonSqlMethodReturnType, type ConnectionPolicies, type DataSourceInput, type DataSourceType, type DateColumnOptions, DryModelQueryBuilder, DryQueryBuilder, type FetchHooks, type GetConnectionReturnType, HysteriaError, InMemoryAdapter, type IndexType, type LazyRelationType, type ManyOptions, type ManyToManyOptions, type ManyToManyStringOptions, Migration, Model, type ModelInstanceType, ModelQueryBuilder, type ModelWithoutRelations, MongoDataSource, type MongoDataSourceInput$1 as MongoDataSourceInput, type MssqlConnectionInstance, type MssqlDataSourceInput, type MssqlPoolInstance, type MysqlConnectionInstance, type MysqlSqlDataSourceInput, type NotNullableMysqlSqlDataSourceInput, type NotNullableOracleDBDataSourceInput, type NotNullableOracleMssqlDataSourceInput, type NotNullablePostgresSqlDataSourceInput, type NotNullableSqliteDataSourceInput, type NumberModelKey, type OneOptions, type OracleDBDataSourceInput, type OracleDBPoolInstance, type PgPoolClientInstance, type PostgresSqlDataSourceInput, QueryBuilder, type RawModelOptions, RawNode, RedisCacheAdapter, type RedisFetchable, type RedisStorable, type RelatedInstance, type RelationQueryBuilderType, type SqlCloneOptions, SqlDataSource, type SqlDataSourceInput, type SqlDataSourceModel, type SqlDataSourceType, type SqlDriverSpecificOptions, type SqlPoolType, type Sqlite3ConnectionOptions, type SqliteConnectionInstance, type SqliteDataSourceInput, type StartTransactionOptions, type SymmetricEncryptionOptions, type TableFormat, type ThroughModel, TimestampedModel, Transaction, type TransactionExecutionOptions, type UniqueType, type UseCacheReturnType, type UseConnectionInput, UserMixin, UuidModel, belongsTo, column, createModelFactory, defineMigrator, generateOpenApiModel, generateOpenApiModelSchema, generateOpenApiModelWithMetadata, getCollectionProperties, getIndexes, getModelColumns, type getPoolReturnType, getPrimaryKey, getRelations, getRelationsMetadata, getUniques, hasMany, hasOne, index, HysteriaLogger as logger, manyToMany, property, RedisDataSource as redis, unique, view, withPerformance };
+export { type AdminJsActionOptions, type AdminJsAssets, type AdminJsBranding, type AdminJsInstance, type AdminJsLocale, type AdminJsOptions, type AdminJsPage, type AdminJsPropertyOptions, type AdminJsResourceOptions, type AdminJsSettings, type AnnotatedModel, type AsymmetricEncryptionOptions, AutogeneratedModel, type BaseModelMethodOptions, type BaseModelRelationType, type CacheAdapter, type CacheKeys, ClientMigrator, Collection, type ColumnDataTypeOption, type ColumnDataTypeOptionSimple, type ColumnDataTypeOptionWithBinary, type ColumnDataTypeOptionWithDatePrecision, type ColumnDataTypeOptionWithEnum, type ColumnDataTypeOptionWithLength, type ColumnDataTypeOptionWithPrecision, type ColumnDataTypeOptionWithScaleAndPrecision, type ColumnDataTypeOptionWithText, type ColumnOptions, type ColumnType, type CommonDataSourceInput, type CommonSqlMethodReturnType, type ConnectionPolicies, type DataSourceInput, type DataSourceType, type DateColumnOptions, DryModelQueryBuilder, DryQueryBuilder, type FetchHooks, type GetConnectionReturnType, HysteriaError, InMemoryAdapter, type IndexType, type LazyRelationType, type ManyOptions, type ManyToManyOptions, type ManyToManyStringOptions, Migration, Model, type ModelInstanceType, ModelQueryBuilder, type ModelWithoutRelations, MongoDataSource, type MongoDataSourceInput$1 as MongoDataSourceInput, type MssqlConnectionInstance, type MssqlDataSourceInput, type MssqlPoolInstance, type MysqlConnectionInstance, type MysqlSqlDataSourceInput, type NotNullableMysqlSqlDataSourceInput, type NotNullableOracleDBDataSourceInput, type NotNullableOracleMssqlDataSourceInput, type NotNullablePostgresSqlDataSourceInput, type NotNullableSqliteDataSourceInput, type NumberModelKey, type OneOptions, type OracleDBDataSourceInput, type OracleDBPoolInstance, type PgPoolClientInstance, type PostgresSqlDataSourceInput, QueryBuilder, type RawModelOptions, RawNode, type RawQueryOptions, RedisCacheAdapter, type RedisFetchable, type RedisStorable, type RelatedInstance, type RelationQueryBuilderType, type ReplicationType, type SlaveAlgorithm, type SqlCloneOptions, SqlDataSource, type SqlDataSourceInput, type SqlDataSourceModel, type SqlDataSourceType, type SqlDriverSpecificOptions, type SqlPoolType, type Sqlite3ConnectionOptions, type SqliteConnectionInstance, type SqliteDataSourceInput, type StartTransactionOptions, type SymmetricEncryptionOptions, type TableFormat, type ThroughModel, TimestampedModel, Transaction, type TransactionExecutionOptions, type UniqueType, type UseCacheReturnType, type UseConnectionInput, UserMixin, UuidModel, belongsTo, column, createModelFactory, defineMigrator, generateOpenApiModel, generateOpenApiModelSchema, generateOpenApiModelWithMetadata, getCollectionProperties, getIndexes, getModelColumns, type getPoolReturnType, getPrimaryKey, getRelations, getRelationsMetadata, getUniques, hasMany, hasOne, index, HysteriaLogger as logger, manyToMany, property, RedisDataSource as redis, unique, view, withPerformance };