feat: Add Oracle Database dialect specific documentation for V7#827
feat: Add Oracle Database dialect specific documentation for V7#827prajalg wants to merge 21 commits intosequelize:mainfrom
Conversation
…e + some changes wherever applicable
… updated releases
|
Thanks for opening this PR! I will take a look at it soon. |
docs/querying/select-in-depth.md
Outdated
| Snowflake: 'https://docs.snowflake.com/en/sql-reference/constructs/join', | ||
| db2: 'https://www.ibm.com/docs/sr/db2-for-zos/11?topic=table-right-outer-join', | ||
| ibmi: 'https://www.ibm.com/docs/en/i/7.4?topic=table-right-outer-join', | ||
| oracle: 'https://docs.oracle.com/javadb/10.8.3.0/ref/rrefsqlj57522.html', |
There was a problem hiding this comment.
Please change this to Oracle and the link to
https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=GUID-70DD48FA-BF46-4479-9C3F-146C5616E440
There was a problem hiding this comment.
Ok thanks! But we have used Oracle Database everywhere and in dialect.ts also. I think we should we use same here too. Or Oracle only at all places.
There was a problem hiding this comment.
Let's use Oracle at all places, consistent with the code PR. There should be a review comment of me asking that where the reply was that oracle is preferred over oracledb
There was a problem hiding this comment.
Okay! Changed Oracle Database to Oracle at all places.
|
Hi @WikiRik, Thanks! |
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation site to include Oracle as a supported dialect in v7, adds a dedicated Oracle database documentation page, and aligns existing tables/links to use the Oracle dialect name so they integrate with the site’s dialect filtering components.
Changes:
- Add a new v7 “Oracle” database documentation page and link it from Getting Started.
- Update v7 & v6 docs tables and references to use the
Oracledialect name (matching the site’s supported dialect list). - Add Oracle to the docs-site dialect support list and update releases + selected feature docs accordingly.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| versioned_docs/version-6.x.x/other-topics/other-data-types.mdx | Rename “Oracle Database” column to “Oracle” for dialect table filtering consistency (v6 docs). |
| versioned_docs/version-6.x.x/other-topics/dialect-specific-things.md | Rename section/link targets from “Oracle Database” to “Oracle” (v6 docs). |
| versioned_docs/version-6.x.x/index.md | Update v6 introduction to refer to “Oracle”. |
| versioned_docs/version-6.x.x/getting-started.md | Update v6 install comment to “Oracle”. |
| src/utils/dialects.ts | Add Oracle to SUPPORTED_DIALECTS, impacting dialect filtering & support tables site-wide. |
| src/pages/releases.mdx | Rename Oracle support section/anchors and update the Oracle support table wording/values. |
| docs/querying/select-in-depth.md | Add Oracle documentation link to the RIGHT JOIN support table. |
| docs/models/data-types.mdx | Add Oracle column entries across multiple datatype tables and add Oracle-specific notes/links. |
| docs/index.mdx | Mention Oracle in the main docs landing page supported databases list. |
| docs/getting-started.mdx | Add Oracle to the list of supported dialect documentation links. |
| docs/databases/oracle.mdx | New dedicated Oracle dialect documentation page (install, config, thick mode notes). |
| docs/_fragments/_uuid-support-table.mdx | Add an Oracle column (currently N/A) to the UUID support table. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| :::note | ||
|
|
||
| For the Oracle dialect `Datatypes.TEXT` doesn't support the `where` option. |
There was a problem hiding this comment.
The note uses Datatypes.TEXT and refers to a non-existent “where option” on the datatype. This is confusing/misleading; consider correcting to DataTypes.TEXT and rephrasing to clearly describe the actual Oracle limitation (e.g., limitations when using CLOB/TEXT columns in where clauses).
| For the Oracle dialect `Datatypes.TEXT` doesn't support the `where` option. | |
| For the Oracle dialect, `DataTypes.TEXT` maps to a CLOB-like type, which has limitations when used in `where` clauses. |
docs/models/data-types.mdx
Outdated
| | Sequelize DataType | [PostgreSQL][postgres-numeric] | [MariaDB][mariadb-numeric] | [MySQL][mysql-numeric] | [MSSQL][mssql-ints] | [SQLite][sqlite-datatypes] | [Snowflake][snowflake-numeric] | db2 | ibmi | [Oracle][oracle-numeric] | | ||
| | -------------------------------------------------------------------------------------- | ------------------------------ | --------------------------------------------------- | ---------------------- | -------------------- | -------------------------- | ------------------------------ | ------------------- | ------------------- | --------------------------- | | ||
| | [`TINYINT`](pathname:///api/v7/classes/_sequelize_core.index.unknown.TINYINT.html) | `SMALLINT`[^ints-1] | [`TINYINT`][mariadb-tinyint] | `TINYINT` | `SMALLINT`[^mssql-1] | `INTEGER` | `INTEGER` | `SMALLINT`[^ints-1] | `SMALLINT`[^ints-1] | `NUMBER(3)` | | ||
| | `TINYINT(1)` | ❌ | `TINYINT(1)` | `TINYINT(1)` | ❌ | ❌ | `❌ | ❌ | ❌ | `NUMBER(3)` | |
There was a problem hiding this comment.
This table row has a broken Snowflake cell: it starts a backtick but never closes it ("`❌"). This will break table rendering; replace it with a plain ❌ or a properly closed inline code span.
docs/models/data-types.mdx
Outdated
| | Sequelize DataType | [PostgreSQL][postgres-numeric] | [MariaDB][mariadb-numeric] | [MySQL][mysql-numeric] | [MSSQL][mssql-ints] | [SQLite][sqlite-datatypes] | [Snowflake][snowflake-numeric] | db2 | ibmi | [Oracle][oracle-numeric] | | ||
| | -------------------------------------------------------------------------------------- | ------------------------------ | --------------------------------------------------- | ---------------------- | -------------------- | -------------------------- | ------------------------------ | ------------------- | ------------------- | --------------------------- | | ||
| | [`TINYINT`](pathname:///api/v7/classes/_sequelize_core.index.unknown.TINYINT.html) | `SMALLINT`[^ints-1] | [`TINYINT`][mariadb-tinyint] | `TINYINT` | `SMALLINT`[^mssql-1] | `INTEGER` | `INTEGER` | `SMALLINT`[^ints-1] | `SMALLINT`[^ints-1] | `NUMBER(3)` | | ||
| | `TINYINT(1)` | ❌ | `TINYINT(1)` | `TINYINT(1)` | ❌ | ❌ | `❌ | ❌ | ❌ | `NUMBER(3)` | |
There was a problem hiding this comment.
Not related to your PR, but:
| | `TINYINT(1)` | ❌ | `TINYINT(1)` | `TINYINT(1)` | ❌ | ❌ | `❌ | ❌ | ❌ | `NUMBER(3)` | | |
| | `TINYINT(1)` | ❌ | `TINYINT(1)` | `TINYINT(1)` | ❌ | ❌ | ❌ | ❌ | ❌ | `NUMBER(3)` | |
| // Thick mode requires Oracle Client or Oracle Instant Client libraries. | ||
| // On Windows and macOS you can specify the directory containing the | ||
| // libraries at runtime or before Node.js starts. On other platforms (where | ||
| // Oracle libraries are available) the system library search path must always |
There was a problem hiding this comment.
This should be ...Oracle Client libraries are available
Added Documentation for Oracle Database Support for v7 sequelize/sequelize#18050