mirror of
https://github.com/logto-io/logto.git
synced 2024-12-23 20:33:16 -05:00
43 lines
1.2 KiB
Markdown
43 lines
1.2 KiB
Markdown
|
# Database Alteration
|
||
|
|
|
||
|
|
The folder for all alteration files.
|
||
|
|
|
||
|
|
## Format
|
||
|
|
|
||
|
|
The alteration files are named in the format of `<version>-<timestamp>-name.js` where `<timestamp>` is the unix timestamp of when the alteration was created and `name` is the name of the alteration, `version` is this npm package's version number.
|
||
|
|
|
||
|
|
As for development, the `version` is "next" until the package is released.
|
||
|
|
|
||
|
|
Note that, you SHOULD NOT change the content of the alteration files after they are created. If you need to change the alteration, you should create a new alteration file with the new content.
|
||
|
|
|
||
|
|
## Typing
|
||
|
|
|
||
|
|
```ts
|
||
|
|
type AlterationScript = {
|
||
|
|
up: (connection: DatabaseTransactionConnection) => Promise<void>;
|
||
|
|
down: (connection: DatabaseTransactionConnection) => Promise<void>;
|
||
|
|
};
|
||
|
|
```
|
||
|
|
|
||
|
|
When the alteration script is executed, the `up` function is called to alter the database schema.
|
||
|
|
|
||
|
|
The `down` function is designed for the future downgrade feature.
|
||
|
|
|
||
|
|
## Example
|
||
|
|
|
||
|
|
```ts
|
||
|
|
export const up = async (connection) => {
|
||
|
|
await connection.query(`
|
||
|
|
ALTER TABLE "user"
|
||
|
|
ADD COLUMN "email" VARCHAR(255) NOT NULL;
|
||
|
|
`);
|
||
|
|
};
|
||
|
|
|
||
|
|
export const down = async (connection) => {
|
||
|
|
await connection.query(`
|
||
|
|
ALTER TABLE "user"
|
||
|
|
DROP COLUMN "email";
|
||
|
|
`);
|
||
|
|
};
|
||
|
|
```
|