Skip to content

docs(seed): document catalog scan and Db2 auth options - #1580

Open
linropx wants to merge 1 commit into
libredb:mainfrom
linropx:codex/docs-seed-connection-options
Open

linropx wants to merge 1 commit into
libredb:mainfrom
linropx:codex/docs-seed-connection-options

Conversation

@linropx

@linropx linropx commented Oct 7, 2026

Copy link
Copy Markdown
Contributor

Description

Document the seed connection options missing from the setup guide: skipObjectScan is optional and absent by default, and true defers catalog loading so the editor is immediately usable. Add a commented Db2 allowInsecureAuth example alongside the engine-specific options.

The example says "Db2 example" because current main also supports this option for InfluxDB and Oxia; the existing field reference documents those engines.

Closes #1264

Type of Change

  • Documentation update

Changes Made

  • Add the connections[].skipObjectScan field-reference row.
  • Add the commented Db2 password-without-TLS example.
  • Only docs/SEED_CONNECTIONS.md changes; no executable code changes.

Testing

Environment: Windows, Node.js 24.19.0, Bun 1.4.2. Existing dependencies were reused from the primary checkout.

  • Passed: bun run format, bun run lint (existing warnings), bun run knip, bun run readme:check, bun run chart:check, bun run channels:showcase:check, bun run security:check, and git diff --check.
  • Parsed the complete YAML configuration example with the project's yaml package and checked both requested additions.
  • The focused runner invocation covered 12 test files: 7 files passed, including all 130 seed-schema tests and all 30 connection-filter tests. Overall it reported 350 passing tests and 9 failures, with 4 additional files unable to load. The failing files were connection-string-records.test.ts and the etcd, Milvus, Neo4j and Oxia provider-doc tests; this checkout lacks newer dependencies such as @grpc/proto-loader and neo4j-driver-lite.
  • bun run typecheck failed with missing dependencies (including Kafka, MCP, Cytoscape and Neo4j) and associated type errors.
  • bun run build failed because Turbopack refuses the worktree's node_modules junction pointing outside its filesystem root.
  • Full bun run test, bun run test:coverage and bun run coverage:check were not run because the local dependency installation is incomplete. No claim of a full green gate or 100% coverage; please run the fork CI checks.

Additional Notes

Prepared with Codex assistance. Full CI remains the merge gate.

@cevheri

cevheri commented Oct 7, 2026

Copy link
Copy Markdown
Member

could you leave a comment on this issue #1264

@cevheri cevheri added the loop:needs-info Maintainer-loop task blocked on human-reviewed clarification label Oct 7, 2026
@cevheri

cevheri commented Oct 7, 2026

Copy link
Copy Markdown
Member

Hi @linropx, thanks for this. Before we review it, I would like to hear about your experience with LibreDB Studio. Which databases do you use it with, local or cloud, and what do you like or find hard in it?

@cevheri cevheri added the documentation Improvements or additions to documentation label Oct 7, 2026

This branch has not been deployed

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

Labels

documentation Improvements or additions to documentation loop:needs-info Maintainer-loop task blocked on human-reviewed clarification

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs/SEED_CONNECTIONS.md: document skipObjectScan and show allowInsecureAuth in the full example

2 participants