Incorrect Example for Defining Composite Primary Keys #456

farhadham · 2024-12-11T13:54:32Z

The current documentation on the Drizzle ORM website provides an incorrect example for defining composite primary keys for postgreSQL using the primaryKey operator. Specifically, the example adds the primaryKey definitions inside an object with keys pk and pkWithCustomName, which does not align with the correct syntax.

Current Example:

export const booksToAuthors = pgTable("books_to_authors", {
  authorId: integer("author_id"),
  bookId: integer("book_id"),
}, (table) => {
  return [{
    pk: primaryKey({ columns: [table.bookId, table.authorId] }),
    pkWithCustomName: primaryKey({ name: 'custom_name', columns: [table.bookId, table.authorId] }),
  }];
});

Expected Example (Correct):

export const booksToAuthors = pgTable(
  "books_to_authors",
  {
    authorId: integer("author_id"),
    bookId: integer("book_id"),
  },
  (table) => {
    return [
      primaryKey({ columns: [table.bookId, table.authorId] }),
      primaryKey({ name: "custom_name", columns: [table.bookId, table.authorId] }),
    ];
  },
);

The current example may mislead developers into defining composite primary keys incorrectly, resulting in potential runtime errors or unexpected behavior when working with Drizzle ORM.

The text was updated successfully, but these errors were encountered:

farhadham linked a pull request Dec 11, 2024 that will close this issue

Fix Incorrect Example for Defining Composite Primary Keys in Documentation #457

Open

hill linked a pull request Dec 11, 2024 that will close this issue

fix: update indexes-constraints page pgTable to the correct signature #453

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Incorrect Example for Defining Composite Primary Keys #456

Incorrect Example for Defining Composite Primary Keys #456

farhadham commented Dec 11, 2024 •

edited

Loading

Incorrect Example for Defining Composite Primary Keys #456

Incorrect Example for Defining Composite Primary Keys #456

Comments

farhadham commented Dec 11, 2024 • edited Loading

Current Example:

Expected Example (Correct):

farhadham commented Dec 11, 2024 •

edited

Loading