Skip to content

docs: point new users at the msnodesqlv8-api-tour app #476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TimelordUK merged 1 commit into from
Oct 11, 2026
Merged

docs: point new users at the msnodesqlv8-api-tour app #476

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .github/RELEASE_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,22 @@ npm install msnodesqlv8

---

## New to msnodesqlv8? Start with the API tour

[**msnodesqlv8-api-tour**](https://github.com/TimelordUK/msnodesqlv8-api-tour)
is one file that walks through the whole API, one copyable section per area:
connections and parameters, streaming with pause / resume, multiple result
sets, prepared statements, stored procedures with output params, transactions,
the table manager's bulk insert / update / delete, BCP, TVPs, geography,
print and error handling, cancel and timeouts, and the connection pool. It
cleans up after itself, so it is safe to re-run and hack on.

```sh
git clone https://github.com/TimelordUK/msnodesqlv8-api-tour && cd msnodesqlv8-api-tour
npm install
CONNECTION_STRING="Driver={ODBC Driver 18 for SQL Server};Server=localhost,1433;Database=tempdb;UID=sa;PWD=...;TrustServerCertificate=yes;" node api-tour.js
```

## Prebuilt binaries ship inside the npm package

Since **5.5.0** the per-platform N-API binary is bundled in the published
Expand Down Expand Up @@ -106,6 +122,7 @@ ways to place one, in increasing order of scope:

| description | link |
|---|---|
| **start here**: the whole API in one runnable file | [msnodesqlv8-api-tour](https://github.com/TimelordUK/msnodesqlv8-api-tour) |
| next js example, note cant run driver on UI thread. | [todo-with-nextjs_msnodesqlv8](https://github.com/TimelordUK/todo-with-nextjs_msnodesqlv8) |
| next js example using app router, note cant run driver on UI thread. | [todo-with-nextjs-app-router_msnodesqlv8](https://github.com/TimelordUK/todo-with-nextjs-app-router_msnodesqlv8) |
| using vite + express | [msnodesqlv8-vite](https://github.com/TimelordUK/msnodesqlv8-vite) |
Expand Down
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ await table.promises.insert(rows) // array-bind, ~130k rows/s
// table.setUseBcp(true) // opt-in to native BCP protocol
```

**New here? Start with the [API tour](https://github.com/TimelordUK/msnodesqlv8-api-tour)**: one runnable file covering the whole API (pool, procs, bulk / BCP, TVP, geography, cancel, print and error handling) that cleans up after itself.

See [samples/javascript/](samples/javascript/) for runnable versions of every snippet below.

---
Expand Down Expand Up @@ -106,6 +108,7 @@ Full runnable projects in their own repos, showing `msnodesqlv8` wired into real

| Stack | Repo |
| ----------------------------- | ---- |
| **Start here: the whole API in one file** | [msnodesqlv8-api-tour](https://github.com/TimelordUK/msnodesqlv8-api-tour) |
| Next.js (pages router) | [todo-with-nextjs_msnodesqlv8](https://github.com/TimelordUK/todo-with-nextjs_msnodesqlv8) |
| Next.js (app router) | [todo-with-nextjs-app-router_msnodesqlv8](https://github.com/TimelordUK/todo-with-nextjs-app-router_msnodesqlv8) |
| Vite + Express | [msnodesqlv8-vite](https://github.com/TimelordUK/msnodesqlv8-vite) |
Expand Down
Loading