Skip to content

Commit 76b8a21

Browse files
authored
Update docs that name in @Index/@UniqueConstraint is optional (#10748)
Fixes #4283.
1 parent b163cea commit 76b8a21

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

docs/en/reference/annotations-reference.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -545,12 +545,12 @@ has meaning in the SchemaTool schema generation context.
545545
Required attributes:
546546

547547

548-
- **name**: Name of the Index
549548
- **fields**: Array of fields. Exactly one of **fields**, **columns** is required.
550549
- **columns**: Array of columns. Exactly one of **fields**, **columns** is required.
551550

552551
Optional attributes:
553552

553+
- **name**: Name of the Index. If not provided, a generated name will be assigned.
554554
- **options**: Array of platform specific options:
555555

556556
- ``where``: SQL WHERE condition to be used for partial indexes. It will
@@ -1316,12 +1316,12 @@ context.
13161316
Required attributes:
13171317

13181318

1319-
- **name**: Name of the Index
13201319
- **fields**: Array of fields. Exactly one of **fields**, **columns** is required.
13211320
- **columns**: Array of columns. Exactly one of **fields**, **columns** is required.
13221321

13231322
Optional attributes:
13241323

1324+
- **name**: Name of the Index. If not provided, a generated name will be assigned.
13251325
- **options**: Array of platform specific options:
13261326

13271327
- ``where``: SQL WHERE condition to be used for partial indexes. It will

docs/en/reference/attributes-reference.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -540,13 +540,13 @@ has meaning in the ``SchemaTool`` schema generation context.
540540

541541
Required parameters:
542542

543-
- **name**: Name of the Index
544543
- **fields**: Array of fields. Exactly one of **fields, columns** is required.
545544
- **columns**: Array of columns. Exactly one of **fields, columns** is required.
546545

547546

548547
Optional parameters:
549548

549+
- **name**: Name of the Index. If not provided, a generated name will be assigned.
550550
- **options**: Array of platform specific options:
551551

552552
- ``where``: SQL WHERE condition to be used for partial indexes. It will
@@ -1104,12 +1104,12 @@ context.
11041104

11051105
Required parameters:
11061106

1107-
- **name**: Name of the Index
11081107
- **fields**: Array of fields (the names of the properties, used in the entity class).
11091108
- **columns**: Array of columns (the names of the columns, used in the schema).
11101109

11111110
Optional parameters:
11121111

1112+
- **name**: Name of the Index. If not provided, a generated name will be assigned.
11131113
- **options**: Array of platform specific options:
11141114

11151115
- ``where``: SQL WHERE condition to be used for partial indexes. It will

0 commit comments

Comments
 (0)