feat(core): add support for indexes on JSON properties #4735
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
Codecov ReportPatch coverage is 📢 Thoughts on this report? Let us know!. |
To create an index on a JSON property, use an entity-level `@Index()` decorator with a dot path: ```ts @entity() @Index({ properties: 'metaData.foo' }) @Index({ properties: ['metaData.foo', 'metaData.bar'] }) // compound index export class Book { @Property({ type: 'json', nullable: true }) metaData?: { foo: string; bar: number }; } ``` In PostgreSQL, this will generate a query like the following: ```sql create index "book_meta_data_foo_index" on "book" (("meta_data"->>'foo')); ``` To create a unique index, use the `@Unique()` decorator: ```ts @entity() @unique({ properties: 'metaData.foo' }) @unique({ properties: ['metaData.foo', 'metaData.bar'] }) // compound unique index export class Book { @Property({ type: 'json', nullable: true }) metaData?: { foo: string; bar: number }; } ``` In MySQL, you can also set the type explicitly: ```ts @entity() @Index({ properties: 'metaData.foo', options: { returning: 'char(200)' } }) export class Book { @Property({ type: 'json', nullable: true }) metaData?: { foo: string; bar: number }; } ``` This will generate a query like the following: ```sql alter table `book` add index `book_meta_data_foo_index`((json_value(`meta_data`, '$.foo' returning char(200)))); ``` > MariaDB driver does not support this feature. Closes #1230
B4nan
added a commit
that referenced
this pull request
Sep 24, 2023
To create an index on a JSON property, use an entity-level `@Index()` decorator with a dot path: ```ts @entity() @Index({ properties: 'metaData.foo' }) @Index({ properties: ['metaData.foo', 'metaData.bar'] }) // compound index export class Book { @Property({ type: 'json', nullable: true }) metaData?: { foo: string; bar: number }; } ``` In PostgreSQL, this will generate a query like the following: ```sql create index "book_meta_data_foo_index" on "book" (("meta_data"->>'foo')); ``` To create a unique index, use the `@Unique()` decorator: ```ts @entity() @unique({ properties: 'metaData.foo' }) @unique({ properties: ['metaData.foo', 'metaData.bar'] }) // compound unique index export class Book { @Property({ type: 'json', nullable: true }) metaData?: { foo: string; bar: number }; } ``` In MySQL, you can also set the type explicitly: ```ts @entity() @Index({ properties: 'metaData.foo', options: { returning: 'char(200)' } }) export class Book { @Property({ type: 'json', nullable: true }) metaData?: { foo: string; bar: number }; } ``` This will generate a query like the following: ```sql alter table `book` add index `book_meta_data_foo_index`((json_value(`meta_data`, '$.foo' returning char(200)))); ``` > MariaDB driver does not support this feature. Closes #1230
B4nan
added a commit
that referenced
this pull request
Sep 30, 2023
To create an index on a JSON property, use an entity-level `@Index()` decorator with a dot path: ```ts @entity() @Index({ properties: 'metaData.foo' }) @Index({ properties: ['metaData.foo', 'metaData.bar'] }) // compound index export class Book { @Property({ type: 'json', nullable: true }) metaData?: { foo: string; bar: number }; } ``` In PostgreSQL, this will generate a query like the following: ```sql create index "book_meta_data_foo_index" on "book" (("meta_data"->>'foo')); ``` To create a unique index, use the `@Unique()` decorator: ```ts @entity() @unique({ properties: 'metaData.foo' }) @unique({ properties: ['metaData.foo', 'metaData.bar'] }) // compound unique index export class Book { @Property({ type: 'json', nullable: true }) metaData?: { foo: string; bar: number }; } ``` In MySQL, you can also set the type explicitly: ```ts @entity() @Index({ properties: 'metaData.foo', options: { returning: 'char(200)' } }) export class Book { @Property({ type: 'json', nullable: true }) metaData?: { foo: string; bar: number }; } ``` This will generate a query like the following: ```sql alter table `book` add index `book_meta_data_foo_index`((json_value(`meta_data`, '$.foo' returning char(200)))); ``` > MariaDB driver does not support this feature. Closes #1230
B4nan
added a commit
that referenced
this pull request
Oct 2, 2023
To create an index on a JSON property, use an entity-level `@Index()` decorator with a dot path: ```ts @entity() @Index({ properties: 'metaData.foo' }) @Index({ properties: ['metaData.foo', 'metaData.bar'] }) // compound index export class Book { @Property({ type: 'json', nullable: true }) metaData?: { foo: string; bar: number }; } ``` In PostgreSQL, this will generate a query like the following: ```sql create index "book_meta_data_foo_index" on "book" (("meta_data"->>'foo')); ``` To create a unique index, use the `@Unique()` decorator: ```ts @entity() @unique({ properties: 'metaData.foo' }) @unique({ properties: ['metaData.foo', 'metaData.bar'] }) // compound unique index export class Book { @Property({ type: 'json', nullable: true }) metaData?: { foo: string; bar: number }; } ``` In MySQL, you can also set the type explicitly: ```ts @entity() @Index({ properties: 'metaData.foo', options: { returning: 'char(200)' } }) export class Book { @Property({ type: 'json', nullable: true }) metaData?: { foo: string; bar: number }; } ``` This will generate a query like the following: ```sql alter table `book` add index `book_meta_data_foo_index`((json_value(`meta_data`, '$.foo' returning char(200)))); ``` > MariaDB driver does not support this feature. Closes #1230
B4nan
added a commit
that referenced
this pull request
Oct 17, 2023
To create an index on a JSON property, use an entity-level `@Index()` decorator with a dot path: ```ts @entity() @Index({ properties: 'metaData.foo' }) @Index({ properties: ['metaData.foo', 'metaData.bar'] }) // compound index export class Book { @Property({ type: 'json', nullable: true }) metaData?: { foo: string; bar: number }; } ``` In PostgreSQL, this will generate a query like the following: ```sql create index "book_meta_data_foo_index" on "book" (("meta_data"->>'foo')); ``` To create a unique index, use the `@Unique()` decorator: ```ts @entity() @unique({ properties: 'metaData.foo' }) @unique({ properties: ['metaData.foo', 'metaData.bar'] }) // compound unique index export class Book { @Property({ type: 'json', nullable: true }) metaData?: { foo: string; bar: number }; } ``` In MySQL, you can also set the type explicitly: ```ts @entity() @Index({ properties: 'metaData.foo', options: { returning: 'char(200)' } }) export class Book { @Property({ type: 'json', nullable: true }) metaData?: { foo: string; bar: number }; } ``` This will generate a query like the following: ```sql alter table `book` add index `book_meta_data_foo_index`((json_value(`meta_data`, '$.foo' returning char(200)))); ``` > MariaDB driver does not support this feature. Closes #1230
B4nan
added a commit
that referenced
this pull request
Oct 21, 2023
To create an index on a JSON property, use an entity-level `@Index()` decorator with a dot path: ```ts @entity() @Index({ properties: 'metaData.foo' }) @Index({ properties: ['metaData.foo', 'metaData.bar'] }) // compound index export class Book { @Property({ type: 'json', nullable: true }) metaData?: { foo: string; bar: number }; } ``` In PostgreSQL, this will generate a query like the following: ```sql create index "book_meta_data_foo_index" on "book" (("meta_data"->>'foo')); ``` To create a unique index, use the `@Unique()` decorator: ```ts @entity() @unique({ properties: 'metaData.foo' }) @unique({ properties: ['metaData.foo', 'metaData.bar'] }) // compound unique index export class Book { @Property({ type: 'json', nullable: true }) metaData?: { foo: string; bar: number }; } ``` In MySQL, you can also set the type explicitly: ```ts @entity() @Index({ properties: 'metaData.foo', options: { returning: 'char(200)' } }) export class Book { @Property({ type: 'json', nullable: true }) metaData?: { foo: string; bar: number }; } ``` This will generate a query like the following: ```sql alter table `book` add index `book_meta_data_foo_index`((json_value(`meta_data`, '$.foo' returning char(200)))); ``` > MariaDB driver does not support this feature. Closes #1230
B4nan
added a commit
that referenced
this pull request
Oct 25, 2023
To create an index on a JSON property, use an entity-level `@Index()` decorator with a dot path: ```ts @entity() @Index({ properties: 'metaData.foo' }) @Index({ properties: ['metaData.foo', 'metaData.bar'] }) // compound index export class Book { @Property({ type: 'json', nullable: true }) metaData?: { foo: string; bar: number }; } ``` In PostgreSQL, this will generate a query like the following: ```sql create index "book_meta_data_foo_index" on "book" (("meta_data"->>'foo')); ``` To create a unique index, use the `@Unique()` decorator: ```ts @entity() @unique({ properties: 'metaData.foo' }) @unique({ properties: ['metaData.foo', 'metaData.bar'] }) // compound unique index export class Book { @Property({ type: 'json', nullable: true }) metaData?: { foo: string; bar: number }; } ``` In MySQL, you can also set the type explicitly: ```ts @entity() @Index({ properties: 'metaData.foo', options: { returning: 'char(200)' } }) export class Book { @Property({ type: 'json', nullable: true }) metaData?: { foo: string; bar: number }; } ``` This will generate a query like the following: ```sql alter table `book` add index `book_meta_data_foo_index`((json_value(`meta_data`, '$.foo' returning char(200)))); ``` > MariaDB driver does not support this feature. Closes #1230
B4nan
added a commit
that referenced
this pull request
Nov 2, 2023
To create an index on a JSON property, use an entity-level `@Index()` decorator with a dot path: ```ts @entity() @Index({ properties: 'metaData.foo' }) @Index({ properties: ['metaData.foo', 'metaData.bar'] }) // compound index export class Book { @Property({ type: 'json', nullable: true }) metaData?: { foo: string; bar: number }; } ``` In PostgreSQL, this will generate a query like the following: ```sql create index "book_meta_data_foo_index" on "book" (("meta_data"->>'foo')); ``` To create a unique index, use the `@Unique()` decorator: ```ts @entity() @unique({ properties: 'metaData.foo' }) @unique({ properties: ['metaData.foo', 'metaData.bar'] }) // compound unique index export class Book { @Property({ type: 'json', nullable: true }) metaData?: { foo: string; bar: number }; } ``` In MySQL, you can also set the type explicitly: ```ts @entity() @Index({ properties: 'metaData.foo', options: { returning: 'char(200)' } }) export class Book { @Property({ type: 'json', nullable: true }) metaData?: { foo: string; bar: number }; } ``` This will generate a query like the following: ```sql alter table `book` add index `book_meta_data_foo_index`((json_value(`meta_data`, '$.foo' returning char(200)))); ``` > MariaDB driver does not support this feature. Closes #1230
B4nan
added a commit
that referenced
this pull request
Nov 5, 2023
To create an index on a JSON property, use an entity-level `@Index()` decorator with a dot path: ```ts @entity() @Index({ properties: 'metaData.foo' }) @Index({ properties: ['metaData.foo', 'metaData.bar'] }) // compound index export class Book { @Property({ type: 'json', nullable: true }) metaData?: { foo: string; bar: number }; } ``` In PostgreSQL, this will generate a query like the following: ```sql create index "book_meta_data_foo_index" on "book" (("meta_data"->>'foo')); ``` To create a unique index, use the `@Unique()` decorator: ```ts @entity() @unique({ properties: 'metaData.foo' }) @unique({ properties: ['metaData.foo', 'metaData.bar'] }) // compound unique index export class Book { @Property({ type: 'json', nullable: true }) metaData?: { foo: string; bar: number }; } ``` In MySQL, you can also set the type explicitly: ```ts @entity() @Index({ properties: 'metaData.foo', options: { returning: 'char(200)' } }) export class Book { @Property({ type: 'json', nullable: true }) metaData?: { foo: string; bar: number }; } ``` This will generate a query like the following: ```sql alter table `book` add index `book_meta_data_foo_index`((json_value(`meta_data`, '$.foo' returning char(200)))); ``` > MariaDB driver does not support this feature. Closes #1230
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.
To create an index on a JSON property, use an entity-level
@Index()decorator with a dot path:In PostgreSQL, this will generate a query like the following:
To create a unique index, use the
@Unique()decorator:In MySQL, you can also set the type explicitly:
This will generate a query like the following:
Closes #1230