-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
- Loading branch information
1 parent
8df7ec5
commit 99b0ef1
Showing
18 changed files
with
308 additions
and
21 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
title: Error.ts | ||
nav_order: 1 | ||
parent: "@sqlfx/mysql2" | ||
--- | ||
|
||
## Error overview | ||
|
||
Added in v1.0.0 | ||
|
||
--- | ||
|
||
<h2 class="text-delta">Table of contents</h2> | ||
|
||
- [exports](#exports) | ||
- [From "@sqlfx/sql/Error"](#from-sqlfxsqlerror) | ||
|
||
--- | ||
|
||
# exports | ||
|
||
## From "@sqlfx/sql/Error" | ||
|
||
Re-exports all named exports from the "@sqlfx/sql/Error" module. | ||
|
||
**Signature** | ||
|
||
```ts | ||
export * from "@sqlfx/sql/Error" | ||
``` | ||
|
||
Added in v1.0.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
--- | ||
title: Migrator.ts | ||
nav_order: 3 | ||
parent: "@sqlfx/mysql2" | ||
--- | ||
|
||
## Migrator overview | ||
|
||
Added in v1.0.0 | ||
|
||
--- | ||
|
||
<h2 class="text-delta">Table of contents</h2> | ||
|
||
- [constructor](#constructor) | ||
- [makeLayer](#makelayer) | ||
- [run](#run) | ||
- [loader](#loader) | ||
- [fromBabelGlob](#frombabelglob) | ||
- [fromDisk](#fromdisk) | ||
- [fromGlob](#fromglob) | ||
|
||
--- | ||
|
||
# constructor | ||
|
||
## makeLayer | ||
|
||
**Signature** | ||
|
||
```ts | ||
export declare const makeLayer: ( | ||
options: _.MigratorOptions | ||
) => Layer.Layer<never, _.MigrationError | SqlError, Sql.MysqlClient> | ||
``` | ||
|
||
Added in v1.0.0 | ||
|
||
## run | ||
|
||
**Signature** | ||
|
||
```ts | ||
export declare const run: ( | ||
options: _.MigratorOptions | ||
) => Effect.Effect<ReadonlyArray<readonly [id: number, name: string]>, SqlError | _.MigrationError, Sql.MysqlClient> | ||
``` | ||
|
||
Added in v1.0.0 | ||
|
||
# loader | ||
|
||
## fromBabelGlob | ||
|
||
**Signature** | ||
|
||
```ts | ||
export declare const fromBabelGlob: (migrations: Record<string, any>) => _.Loader | ||
``` | ||
|
||
Added in v1.0.0 | ||
|
||
## fromDisk | ||
|
||
**Signature** | ||
|
||
```ts | ||
export declare const fromDisk: (directory: string) => _.Loader | ||
``` | ||
|
||
Added in v1.0.0 | ||
|
||
## fromGlob | ||
|
||
**Signature** | ||
|
||
```ts | ||
export declare const fromGlob: (migrations: Record<string, () => Promise<any>>) => _.Loader | ||
``` | ||
|
||
Added in v1.0.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
title: "@sqlfx/mysql2" | ||
has_children: true | ||
permalink: /docs/mysql2 | ||
nav_order: 4 | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,128 @@ | ||
--- | ||
title: index.ts | ||
nav_order: 2 | ||
parent: "@sqlfx/mysql2" | ||
--- | ||
|
||
## index overview | ||
|
||
Added in v1.0.0 | ||
|
||
--- | ||
|
||
<h2 class="text-delta">Table of contents</h2> | ||
|
||
- [constructor](#constructor) | ||
- [MysqlClientConfig (interface)](#mysqlclientconfig-interface) | ||
- [make](#make) | ||
- [makeCompiler](#makecompiler) | ||
- [makeLayer](#makelayer) | ||
- [model](#model) | ||
- [MysqlClient (interface)](#mysqlclient-interface) | ||
- [tag](#tag) | ||
- [tag](#tag-1) | ||
- [utils](#utils) | ||
- [transform](#transform) | ||
|
||
--- | ||
|
||
# constructor | ||
|
||
## MysqlClientConfig (interface) | ||
|
||
**Signature** | ||
|
||
```ts | ||
export interface MysqlClientConfig { | ||
/** | ||
* Connection URI. Setting this will override the other connection options | ||
*/ | ||
readonly url?: Secret.Secret | ||
|
||
readonly host?: string | ||
readonly port?: number | ||
readonly database?: string | ||
readonly username?: string | ||
readonly password?: Secret.Secret | ||
|
||
readonly maxConnections?: number | ||
readonly connectionTTL?: Duration.DurationInput | ||
|
||
readonly poolConfig?: Mysql.PoolOptions | ||
|
||
readonly transformResultNames?: (str: string) => string | ||
readonly transformQueryNames?: (str: string) => string | ||
} | ||
``` | ||
|
||
Added in v1.0.0 | ||
|
||
## make | ||
|
||
**Signature** | ||
|
||
```ts | ||
export declare const make: (options: MysqlClientConfig) => Effect.Effect<MysqlClient, never, Scope> | ||
``` | ||
|
||
Added in v1.0.0 | ||
|
||
## makeCompiler | ||
|
||
**Signature** | ||
|
||
```ts | ||
export declare const makeCompiler: (transform?: ((_: string) => string) | undefined) => Statement.Compiler | ||
``` | ||
|
||
Added in v1.0.0 | ||
|
||
## makeLayer | ||
|
||
**Signature** | ||
|
||
```ts | ||
export declare const makeLayer: (config: Config.Config.Wrap<MysqlClientConfig>) => Layer.Layer<MysqlClient, ConfigError> | ||
``` | ||
|
||
Added in v1.0.0 | ||
|
||
# model | ||
|
||
## MysqlClient (interface) | ||
|
||
**Signature** | ||
|
||
```ts | ||
export interface MysqlClient extends Client.Client { | ||
readonly config: MysqlClientConfig | ||
} | ||
``` | ||
|
||
Added in v1.0.0 | ||
|
||
# tag | ||
|
||
## tag | ||
|
||
**Signature** | ||
|
||
```ts | ||
export declare const tag: Tag<MysqlClient, MysqlClient> | ||
``` | ||
|
||
Added in v1.0.0 | ||
|
||
# utils | ||
|
||
## transform | ||
|
||
Column renaming helpers. | ||
|
||
**Signature** | ||
|
||
```ts | ||
export declare const transform: typeof transform | ||
``` | ||
|
||
Added in v1.0.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,14 @@ | ||
# @sqlfx/mysql2 | ||
|
||
## 0.1.0 | ||
|
||
### Minor Changes | ||
|
||
- [#178](https://github.com/tim-smart/sqlfx/pull/178) [`8df7ec5`](https://github.com/tim-smart/sqlfx/commit/8df7ec5f76b1b21d00dbfc942e9d3a1b10dde1eb) Thanks [@jamiehodge](https://github.com/jamiehodge)! - initial version | ||
|
||
### Patch Changes | ||
|
||
- [#178](https://github.com/tim-smart/sqlfx/pull/178) [`8df7ec5`](https://github.com/tim-smart/sqlfx/commit/8df7ec5f76b1b21d00dbfc942e9d3a1b10dde1eb) Thanks [@jamiehodge](https://github.com/jamiehodge)! - fix tag identifiers | ||
|
||
- Updated dependencies [[`8df7ec5`](https://github.com/tim-smart/sqlfx/commit/8df7ec5f76b1b21d00dbfc942e9d3a1b10dde1eb)]: | ||
- @sqlfx/sql@0.46.1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.