Skip to content

docs: publish adoption and support guides - #23

Merged
omer-cengel merged 1 commit into
masterfrom
chore/publish-adoption-and-support-docs
Sep 22, 2026
Merged

omer-cengel merged 1 commit into
masterfrom
chore/publish-adoption-and-support-docs

Conversation

@omer-cengel

Copy link
Copy Markdown
Member

Summary

Publish a focused adoption path and support reference for using sqlcj’s packaged CLI and runtime from a Java 21 Maven application without implying public artifact availability.

Changes

  • Add a concise README covering prerequisites, locally built artifacts, CLI commands, version compatibility, and the public documentation set.
  • Add an end-to-end PostgreSQL quickstart covering generation, compilation, CRUD execution, caller-managed transactions, stale output, and schema-snapshot ownership.
  • Document supported query shapes, cardinality, parameters, generated APIs, and unsupported behavior.
  • Publish the configuration reference and connect it with the PostgreSQL support documentation.
  • Clarify that analysis failures precede output writes while filesystem writes are sequential rather than transactional.

Scope and non-goals

  • Documentation only; product code, tests, build configuration, generated files, and supported SQL behavior are unchanged.
  • Generation remains a separate CLI step rather than Maven or Gradle lifecycle integration.
  • The documented artifacts are locally staged pre-release artifacts; this change does not add licensing, public publication, signing, release automation, or external-sample CI.

@omer-cengel
omer-cengel merged commit 5c93e45 into master Sep 22, 2026
6 checks passed
@omer-cengel
omer-cengel deleted the chore/publish-adoption-and-support-docs branch September 22, 2026 22:55
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.

1 participant