Skip to content

Commit 3a31e05

Browse files
committed
docs: Add spatialIndexes to table of contents for Keys section
Missed adding it in the commit when spatial indexes where first introduced. [ci skip]
1 parent 35a548f commit 3a31e05

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1047,11 +1047,12 @@ See the [Column Types](#column-types) section for all possible column types and
10471047

10481048
### Keys
10491049

1050-
There are three properties that can be used to define different types of keys:
1050+
The following properties can be used to define different types of keys:
10511051

10521052
+ [`primaryKey`](#primarykey--stringstring)
10531053
+ [`uniqueKeys`](#uniquekeys--arraystringstring)
10541054
+ [`indexes`](#indexes--arraystringstring)
1055+
+ [`spatialIndexes`](#spatialindexes--string)
10551056

10561057
Note that [column definitions](#columndefinition) allow you to define these keys directly on the column. If you use that method of defining a key for a column, you should not define the key again using one of these properties.
10571058

@@ -1104,7 +1105,7 @@ Used to define the table's indexes. Its value is an array where the elements are
11041105

11051106
Used to define the table's spatial indexes. Its value is an array where the elements are the column name for each index.
11061107

1107-
Note that spatial indexes may each only have 1 column and they may only be defined for geometrical type columns.
1108+
Note that spatial indexes may each only have 1 column and they may only be defined for [geometry-type](https://dev.mysql.com/doc/refman/5.7/en/spatial-type-overview.html) columns.
11081109

11091110
**Example:**
11101111
```js

jsdoc2md/README.hbs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,11 +161,12 @@ See the [Column Types](#column-types) section for all possible column types and
161161

162162
### Keys
163163

164-
There are three properties that can be used to define different types of keys:
164+
The following properties can be used to define different types of keys:
165165

166166
+ [`primaryKey`](#primarykey--stringstring)
167167
+ [`uniqueKeys`](#uniquekeys--arraystringstring)
168168
+ [`indexes`](#indexes--arraystringstring)
169+
+ [`spatialIndexes`](#spatialindexes--string)
169170

170171
Note that [column definitions](#columndefinition) allow you to define these keys directly on the column. If you use that method of defining a key for a column, you should not define the key again using one of these properties.
171172

@@ -218,7 +219,7 @@ Used to define the table's indexes. Its value is an array where the elements are
218219

219220
Used to define the table's spatial indexes. Its value is an array where the elements are the column name for each index.
220221

221-
Note that spatial indexes may each only have 1 column and they may only be defined for geometrical type columns.
222+
Note that spatial indexes may each only have 1 column and they may only be defined for [geometry-type](https://dev.mysql.com/doc/refman/5.7/en/spatial-type-overview.html) columns.
222223

223224
**Example:**
224225
```js

0 commit comments

Comments
 (0)