Skip to content

feat: Add Oracle Database dialect specific documentation for V7#827

Open
prajalg wants to merge 21 commits intosequelize:mainfrom
prajalg:v7_docs_oracle
Open

feat: Add Oracle Database dialect specific documentation for V7#827
prajalg wants to merge 21 commits intosequelize:mainfrom
prajalg:v7_docs_oracle

Conversation

@prajalg
Copy link
Copy Markdown

@prajalg prajalg commented Feb 23, 2026

Added Documentation for Oracle Database Support for v7 sequelize/sequelize#18050

@prajalg prajalg requested a review from a team as a code owner February 23, 2026 13:02
@prajalg prajalg requested review from ephys and sdepold February 23, 2026 13:02
Copy link
Copy Markdown
Contributor

@sudarshan12s sudarshan12s left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@WikiRik
Copy link
Copy Markdown
Member

WikiRik commented Feb 24, 2026

Thanks for opening this PR! I will take a look at it soon.

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',
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay! Changed Oracle Database to Oracle at all places.

@prajalg
Copy link
Copy Markdown
Author

prajalg commented Mar 10, 2026

Hi @WikiRik,
Just a gentle follow-up on this PR. Whenever you have time to take a look, I'd really appreciate it.

Thanks!

@WikiRik WikiRik self-requested a review April 2, 2026 19:46
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 Oracle dialect 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.
Copy link

Copilot AI Apr 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Suggested change
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.

Copilot uses AI. Check for mistakes.
| 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)` |
Copy link

Copilot AI Apr 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Member

@ephys ephys left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! Looks good to me

| 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)` |
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not related to your PR, but:

Suggested change
| `TINYINT(1)` || `TINYINT(1)` | `TINYINT(1)` ||| `||| `NUMBER(3)` |
| `TINYINT(1)` || `TINYINT(1)` | `TINYINT(1)` |||||| `NUMBER(3)` |

@ephys ephys mentioned this pull request Apr 6, 2026
// 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
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be ...Oracle Client libraries are available

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants