Skip to content

Commit

Permalink
docs: fix typo in the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@yujiosaka
yujiosaka committed Jun 18, 2024
1 parent 7690fb4 commit 3a7d05c
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,16 +104,16 @@ Sequelize Revision supports various options that can be passed into the initiali

### Revision

| Attribute | Data Type | Description |
| ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `"id"` | [INTEGER](https://sequelize.org/api/v6/class/src/data-types.js~integer) \| [UUID](https://sequelize.org/api/v6/class/src/data-types.js~uuid) | Primary key of the model. Data type is [INTEGER](https://sequelize.org/api/v6/class/src/data-types.js~integer) by default, but can be modified to [UUID](https://sequelize.org/api/v6/class/src/data-types.js~uuid) for PostgreSQL by passing `"uuid"` to **[primaryKeyType]** option. |
| `"model"` | [STRING](https://sequelize.org/api/v6/class/src/data-types.js~string) | Name of the tracked model. |
| `"document"` | [JSON](https://sequelize.org/api/v6/class/src/data-types.js~jsontype) \| [TEXT("medium")](https://sequelize.org/api/v6/class/src/data-types.js~text) | Attributes of the model after the operation. The entire attributes are saved by default, but can be compresses only to the diff by passing **[enableCompression]** option. |
| `"documentId"` `"documentIds"` | [INTEGER](https://sequelize.org/api/v6/class/src/data-types.js~integer) \| [UUID](https://sequelize.org/api/v6/class/src/data-types.js~uuid) , .js~uuid) s | ID of the tracked document. The first ID is used for a composite key. Attribute name can be modified to `"document_id"` by passing **[underscoredAttributes]** option. |
| `"documentIds"` `"documentIds"` | [JSON](https://sequelize.org/api/v6/class/src/data-types.js~jsontype) \| [TEXT("medium")](https://sequelize.org/api/v6/class/src/data-types.js~, /data-types.jss~text) | IDs of the tracked document. Attribute name can be modified to `"document_ids"` by passing **[underscoredAttributes]** option. |
| `"operation"` | [STRING](https://sequelize.org/api/v6/class/src/data-types.js~string) | Name of the operation such as `"create"`, `"update"` and `"destroy"`. |
| **[revisionAttribute]** | [INTEGER](https://sequelize.org/api/v6/class/src/data-types.js~integer) | Version of the document starting from `1`. The value is incremented every time when the document is created, updated or deleted. Attribute name is configured by **[revisionAttribute]**, default to `"revision"`. The same value is saved to **[revisionAttribute]** attribute of the tracked document as well. |
| **[userIdAttribute]** | (ID data type of of the user model) | Foreign key of the user model. Attribute name is configured by **[userIdAttribute]**, default to `"userId"` and modified to `"user_id"` by passing **[underscoredAttributes]** option. |
| Attribute | Data Type | Description |
| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `"id"` | [INTEGER](https://sequelize.org/api/v6/class/src/data-types.js~integer) \| [UUID](https://sequelize.org/api/v6/class/src/data-types.js~uuid) | Primary key of the model. Data type is [INTEGER](https://sequelize.org/api/v6/class/src/data-types.js~integer) by default, but can be modified to [UUID](https://sequelize.org/api/v6/class/src/data-types.js~uuid) for PostgreSQL by passing `"uuid"` to **[primaryKeyType]** option. |
| `"model"` | [STRING](https://sequelize.org/api/v6/class/src/data-types.js~string) | Name of the tracked model. |
| `"document"` | [JSON](https://sequelize.org/api/v6/class/src/data-types.js~jsontype) \| [TEXT("medium")](https://sequelize.org/api/v6/class/src/data-types.js~text) | Attributes of the model after the operation. The entire attributes are saved by default, but can be compresses only to the diff by passing **[enableCompression]** option. |
| `"documentId"` | [INTEGER](https://sequelize.org/api/v6/class/src/data-types.js~integer) \| [UUID](https://sequelize.org/api/v6/class/src/data-types.js~uuid) | ID of the tracked document. The first ID is used for a composite key. Attribute name can be modified to `"document_id"` by passing **[underscoredAttributes]** option. |
| `"documentIds"` | [JSON](https://sequelize.org/api/v6/class/src/data-types.js~jsontype) \| [TEXT("medium")](https://sequelize.org/api/v6/class/src/data-types.js~text) | Composite IDs of the tracked document. Attribute name can be modified to `"document_ids"` by passing **[underscoredAttributes]** option. |
| `"operation"` | [STRING](https://sequelize.org/api/v6/class/src/data-types.js~string) | Name of the operation such as `"create"`, `"update"` and `"destroy"`. |
| **[revisionAttribute]** | [INTEGER](https://sequelize.org/api/v6/class/src/data-types.js~integer) | Version of the document starting from `1`. The value is incremented every time when the document is created, updated or deleted. Attribute name is configured by **[revisionAttribute]**, default to `"revision"`. The same value is saved to **[revisionAttribute]** attribute of the tracked document as well. |
| **[userIdAttribute]** | (ID data type of of the user model) | Foreign key of the user model. Attribute name is configured by **[userIdAttribute]**, default to `"userId"` and modified to `"user_id"` by passing **[underscoredAttributes]** option. |

### RevisionChnage

Expand Down

0 comments on commit 3a7d05c

Please sign in to comment.