Add support for combined (multiple) primary keys

.devcontainer.json

@@ -0,0 +1,7 @@
+// For format details, see https://aka.ms/devcontainer.json.
+{
+  "name": "knex-schema-inspector",
+  "dockerComposeFile": "docker/docker-compose.vscode.yml",
+  "service": "dev",
+  "workspaceFolder": "/ws/${localWorkspaceFolderBasename}"
+}

.github/workflows/tests.yml

@@ -1,6 +1,6 @@
 name: Tests
 
-on: [push, pull_request]
+on: [push, pull_request, workflow_dispatch]
 
 defaults:
   run:
@@ -12,32 +12,52 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [14.x]
-
-    env:
-      LD_LIBRARY_PATH: /opt/oracle/instantclient_21_1
+        node-version: [20, 22]
 
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout code
+        uses: actions/checkout@v4
 
-      - name: Install Oracle client
-        run: |
-          sudo apt install unzip
-          wget -q https://download.oracle.com/otn_software/linux/instantclient/211000/instantclient-basiclite-linux.x64-21.1.0.0.0.zip
-          sudo mkdir -p /opt/oracle
-          sudo unzip -qo instantclient-basiclite-linux.x64-21.1.0.0.0.zip -d /opt/oracle
+      - name: init apt
+        run: sudo apt update
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
+          cache: 'pnpm'
+
+      - name: Starting DB services under docker
+        run: docker compose --file 'docker/docker-compose.yml' up -d
+
+      - name: Install dependencies
+        run: pnpm install
 
-      - run: docker-compose up -d
+      - name: Fix sqlite pnpm bug
+        run: |
+          pnpm install sqlite3 better-sqlite3
+          cd node_modules/sqlite3; pnpm rebuild
+          cd ../better-sqlite3; pnpm rebuild
+
+      - name: Wait for mysql DB services to be ready
+        run: |
+          while ! docker compose --file 'docker/docker-compose.yml' logs mysql | grep -q 'mysqld: ready for connections.'; do sleep 2; done
 
-      - run: npm ci
+      - name: Wait for postgres DB services to be ready
+        run: |
+          while ! docker compose --file 'docker/docker-compose.yml' logs postgres | grep -q 'database system is ready to accept connections'; do sleep 2; done
+
+      - name: Wait for mssql DB services to be ready
+        run: |
+          while ! docker compose --file 'docker/docker-compose.yml' logs mssql | grep -q 'SQL Server is now ready for client connections'; do sleep 2; done
 
-      - run: "while ! docker-compose logs mysql | grep -q 'mysqld: ready for connections.'; do sleep 2; done"
-      - run: "while ! docker-compose logs postgres | grep -q 'database system is ready to accept connections'; do sleep 2; done"
-      - run: "while ! docker-compose logs mssql | grep -q 'SQL Server is now ready for client connections'; do sleep 2; done"
+      - name: Run tests
+        run: pnpm test
 
-      - run: npm test
+      - name: Stop DB services
+        run: docker compose --file 'docker/docker-compose.yml' down

.prettierignore

@@ -1 +1,2 @@
 dist
+pnpm-lock.yaml

CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [3.1.1] - 2025-08-21
+
+### Added
+
+- Support for combined (composite) primary keys in [`primary`](README.md#primarytable-string-promisestring--string--null).
+
+### Changed
+
+- Moved to pnpm
+
+### Fixed
+
+- Fix detection of foreign keys in CockroachDB where always returned pk of first table
+- Update library to latest
+- Fix Github action
+
+## [3.1.0] - 2023-10-23
+
+### Added
+
+- Add support for better-sqlite3.
+
+### Changed
+
+- MySQL Optimization
+
+## [3.0.1] - 2023-01-30
+
+### Fixed
+
+- Fix CrDB auto-increment detection ([#135](https://github.com/knex/knex-schema-inspector/issues/135))

README.md

@@ -2,7 +2,7 @@
 
 Utility for extracting information about existing DB schema
 
-This library currently supports Postgres, MySQL, MS SQL, SQLite, and OracleDB. We aim to have support for the same databases as the main knex project.
+This library currently supports CockroachDB, Postgres, MySQL, MS SQL, SQLite, and OracleDB. We aim to have support for the same databases as the main knex project.
 
 ## Installation
 
@@ -71,7 +71,7 @@ Note 3: MSSQL doesn't support comment for either tables or columns
 
 - [`columns(table?: string): Promise<{ table: string, column: string }[]>`](#columnstable-string-promise-table-string-column-string-)
 - [`columnInfo(table?: string, column?: string): Promise<Column[] | Column>`](#columninfotable-string-column-string-promisecolumn--column)
-- [`primary(table: string): Promise<string>`](#primarytable-string-promisestring)
+- [`primary(table: string): Promise<string | string[] | null>`](#primarytable-string-promisestring--string--null)
 
 **Foreign Keys**
 
@@ -207,15 +207,24 @@ await inspector.columnInfo('articles', 'id');
 //  }
 ```
 
-#### `primary(table: string): Promise<string>`
+#### `primary(table: string): Promise<string | string[] | null>`
 
-Retrieve the primary key column for a given table
+Retrieve the primary key columns for a given table.
+
+If there is only one primary key for a given table, it return as a string. (This is the only return in ver <= 3.1.0)
 
 ```ts
 await inspector.primary('articles');
 // => "id"
 ```
 
+If table has a combined (multiple) primary keys, they are return as an array of string. Version previous 3.1.0 doesn't support combined pks and in this case it returned the first pk only.
+
+```ts
+await inspector.primary('article_comments');
+// => ["article_id","comment_id"]
+```
+
 ### Foreign Keys
 
 Retrieve all configured foreign key constraints.

docker/dev/Dockerfile

@@ -0,0 +1,42 @@
+# config 
+ARG IDIR
+# development|production
+ARG BMODE=development
+
+# 01a - base image
+FROM ebruni/pnpm AS base
+ARG IDIR
+# add node_modules executables to PATH
+ENV PATH="/ws/${IDIR}/node_modules/.bin:${PATH}"
+
+# 02a - Install dependencies only when package.json changes
+FROM base AS deps
+ARG IDIR
+ARG BMODE
+ENV NODE_ENV=${BMODE}
+WORKDIR /ws/${IDIR}
+# Install dependencies based on the preferred package manager
+COPY --chown=node:node . ./
+RUN --mount=type=cache,id=ksi_pnpm-store,uid=1000,gid=1000,target=/home/node/pnpm/store [ -e pnpm-lock.yaml ] && pnpm install --frozen-lockfile || pnpm install
+
+# 03a - Rebuild the source code only when needed
+FROM base AS builder
+ARG IDIR
+ARG BMODE
+ENV NODE_ENV=${BMODE}
+WORKDIR /ws/${IDIR}
+COPY --chown=node:node . ./
+COPY --chown=node:node --from=deps ws/${IDIR}/pnpm-lock.yaml* .
+COPY --chown=node:node --from=deps ws/${IDIR}/node_modules ./node_modules
+
+# 04a - Production image
+FROM base AS runner
+ARG IDIR
+ARG BMODE
+ENV NODE_ENV=\${BMODE}
+WORKDIR /ws/${IDIR}
+
+COPY --from=builder ws/${IDIR}/node_modules ./node_modules
+COPY --from=builder ws/${IDIR}/package.json ws/${IDIR}/pnpm-lock.yaml* ./
+
+CMD [""]

docker/docker-compose.vscode.yml

@@ -0,0 +1,30 @@
+services:
+  dev:
+    image: vs-knex-schema-inspector
+    build:
+      context: ../
+      dockerfile: docker/dev/Dockerfile
+      args:
+        - IDIR=knex-schema-inspector
+    volumes:
+      - ../:/ws/knex-schema-inspector:cached
+      - lib-modules:/ws/knex-schema-inspector/node_modules
+
+    # Overrides default command so things don't shut down after the process ends.
+    command: sleep infinity
+    env_file: ../.env
+    environment:
+      # not in .env because .env can be used in prod too
+      FORCE_UID: 1001
+      FORCE_GID: 1001
+    deploy:
+      resources:
+        limits:
+          cpus: '2'
+volumes:
+  lib-modules:
+
+networks:
+  default:
+    name: docker_default
+    external: true

docker-compose.yml → docker/docker-compose.yml

@@ -1,4 +1,3 @@
-version: '3.1'
 services:
   mysql:
     image: mysql:5.7
@@ -9,7 +8,7 @@ services:
     ports:
       - 5100:3306
     volumes:
-      - ./test/seed/mysql.sql:/docker-entrypoint-initdb.d/seed.sql
+      - ../test/seed/mysql.sql:/docker-entrypoint-initdb.d/seed.sql
   postgres:
     image: postgres:12.3
     restart: always
@@ -19,7 +18,7 @@ services:
     ports:
       - 5101:5432
     volumes:
-      - ./test/seed/postgres.sql:/docker-entrypoint-initdb.d/seed.sql
+      - ../test/seed/postgres.sql:/docker-entrypoint-initdb.d/seed.sql
 
   postgres10:
     image: postgres:10
@@ -30,7 +29,7 @@ services:
     ports:
       - 5102:5432
     volumes:
-      - ./test/seed/postgres10.sql:/docker-entrypoint-initdb.d/seed.sql
+      - ../test/seed/postgres10.sql:/docker-entrypoint-initdb.d/seed.sql
 
   mssql:
     image: mcr.microsoft.com/mssql/server:2017-CU24-ubuntu-16.04
@@ -44,7 +43,7 @@ services:
       - 1433:1433
     volumes:
       - mssql-volume:/var/opt/mssql/
-      - ./test:/tmp/test
+      - ../test:/tmp/test
 
   # Note: you need to be logged in to DockerHub, and accept the EULA for oracle/database-enterprise to work
   #       ... no clue how to get around that in GH Actions for tests ...
@@ -68,24 +67,24 @@ services:
     working_dir: /tmp/test
     command: sh -c './scripts/oracle-entrypoint.sh'
     volumes:
-      - ./test:/tmp/test
+      - ../test:/tmp/test
 
   cockroachdb:
-    image: cockroachdb/cockroach:latest-v21.1
+    image: cockroachdb/cockroach:latest-v21.2
     container_name: crdb
     hostname: crdb
     command: start-single-node --cluster-name=example-single-node --insecure
     volumes:
-      - ./test/seed/postgres.sql:/docker-entrypoint-initdb.d/seed.sql
+      - ../test/seed/postgres.sql:/docker-entrypoint-initdb.d/seed.sql
     ports:
       - '26257:26257'
       - '8080:8080'
 
   cockroachdb-init:
-    image: cockroachdb/cockroach:latest-v21.1
+    image: cockroachdb/cockroach:latest-v21.2
     volumes:
-      - ./test/seed/cockroachdb.sql:/seed.sql
-      - ./test/scripts/cockroachdb-init.sh:/init.sh
+      - ../test/seed/cockroachdb.sql:/seed.sql
+      - ../test/scripts/cockroachdb-init.sh:/init.sh
     entrypoint: '/bin/bash'
     command: /init.sh
 

lib/dialects/cockroachdb.ts

@@ -166,10 +166,9 @@ export default class CockroachDB implements SchemaInspector {
    */
   async columns(table?: string) {
     const query = this.knex
-      .select<{ table_name: string; column_name: string }[]>(
-        'table_name',
-        'column_name'
-      )
+      .select<
+        { table_name: string; column_name: string }[]
+      >('table_name', 'column_name')
       .from('information_schema.columns')
       .whereIn('table_schema', this.explodedSchema);
 
@@ -345,26 +344,35 @@ export default class CockroachDB implements SchemaInspector {
   /**
    * Get the primary key column for the given table
    */
-  async primary(table: string): Promise<string> {
+  async primary(table: string) {
     const result = await this.knex
       .select('information_schema.key_column_usage.column_name')
       .from('information_schema.key_column_usage')
-      .leftJoin(
-        'information_schema.table_constraints',
-        'information_schema.table_constraints.constraint_name',
-        'information_schema.key_column_usage.constraint_name'
-      )
+      .leftJoin('information_schema.table_constraints', function () {
+        this.on(
+          'information_schema.table_constraints.constraint_name',
+          '=',
+          'information_schema.key_column_usage.constraint_name'
+        ).andOn(
+          'information_schema.table_constraints.table_name',
+          '=',
+          'information_schema.key_column_usage.table_name'
+        );
+      })
       .whereIn(
         'information_schema.table_constraints.table_schema',
         this.explodedSchema
       )
       .andWhere({
         'information_schema.table_constraints.constraint_type': 'PRIMARY KEY',
         'information_schema.table_constraints.table_name': table,
-      })
-      .first();
+      });
 
-    return result ? result.column_name : null;
+    return result.length > 0
+      ? result.length === 1
+        ? (result[0].column_name as string)
+        : (result.map((r) => r.column_name) as string[])
+      : null;
   }
 
   // Foreign Keys