Add storage engine index type doc #4756 #345
Merged
Conversation
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
Collaborator
OlivierCavadenti
commented
Oct 20, 2021
OlivierCavadenti
commented
- Documentation for Add storage engine index Type support to MySQL index() and unique() schema knex#4756
kibertoad
reviewed
Oct 20, 2021
sections/schema.js
Outdated
| example: "table.index(columns, [indexName], [indexType])", | ||
| description: "Adds an index to a table over the given columns. A default index name using the columns is used unless indexName is specified. The indexType can be optionally specified for PostgreSQL and MySQL. Amazon Redshift does not allow creating an index.", | ||
| children: [ ] | ||
| example: "table.index(columns,[indexName]|{[indexName: string],[storageEngineIndexType:'btree'|'hash']}, [indexType])", |
kibertoad
reviewed
Oct 20, 2021
sections/schema.js
Outdated
| @@ -798,8 +798,8 @@ export default [ | |||
| type: "method", | |||
| method: "unique", | |||
| href:"Schema-table-unique", | |||
| example: "table.unique(columns, options={[indexName:string],[deferrable:'not deferrable'|'immediate'|'deferred']})", | |||
| description: "Adds an unique index to a table over the given `columns`. A default index name using the columns is used unless indexName is specified. If you need to create a composite index, pass an array of column to `columns`. Deferrable unique constraint are supported on Postgres and Oracle and can be set by passing deferrable option to options object.", | |||
| example: "table.unique(columns, options={[indexName:string],[deferrable:'not deferrable'|'immediate'|'deferred'],[storageEngineIndexType:'btree'|'hash']})", | |||
kibertoad
reviewed
Oct 20, 2021
sections/schema.js
Outdated
| example: "table.unique(columns, options={[indexName:string],[deferrable:'not deferrable'|'immediate'|'deferred']})", | ||
| description: "Adds an unique index to a table over the given `columns`. A default index name using the columns is used unless indexName is specified. If you need to create a composite index, pass an array of column to `columns`. Deferrable unique constraint are supported on Postgres and Oracle and can be set by passing deferrable option to options object.", | ||
| example: "table.unique(columns, options={[indexName:string],[deferrable:'not deferrable'|'immediate'|'deferred'],[storageEngineIndexType:'btree'|'hash']})", | ||
| description: "Adds an unique index to a table over the given `columns`. In MySQL, the storage engine index type can be specified between 'btree' or 'hash' index types, more info in Index Options section : https://dev.mysql.com/doc/refman/8.0/en/create-index.html. A default index name using the columns is used unless indexName is specified. If you need to create a composite index, pass an array of column to `columns`. Deferrable unique constraint are supported on Postgres and Oracle and can be set by passing deferrable option to options object.", |
There was a problem hiding this comment.
specified between sounds off
kibertoad
reviewed
Oct 20, 2021
sections/schema.js
Outdated
| @@ -809,7 +809,7 @@ export default [ | |||
| t.unique('email') | |||
| }) | |||
| knex.schema.alterTable('job', function(t) { | |||
| t.unique(['account_id', 'program_id'],{indexName:'users_composite_index',deferrable:'deferred'}) | |||
| t.unique(['account_id', 'program_id'],{indexName:'users_composite_index',deferrable:'deferred',storageEngineIndexType: 'hash'}) | |||
kibertoad
reviewed
Oct 20, 2021
sections/schema.js
Outdated
| @@ -957,8 +957,8 @@ export default [ | |||
| { | |||
| type: "method", | |||
| method: "index", | |||
| example: "column.index([indexName], [indexType])", | |||
| description: "Specifies a field as an index. If an indexName is specified, it is used in place of the standard index naming convention of tableName_columnName. The indexType can be optionally specified for PostgreSQL and MySQL. No-op if this is chained off of a field that cannot be indexed.", | |||
| example: "column.index([indexName]|{[indexName: string],[storageEngineIndexType:'btree'|'hash']}, [indexType])", | |||
kibertoad
approved these changes
Oct 20, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.