mssql

mssql API Reference

mssql (node-mssql) — a Microsoft SQL Server client for Node.js by tediousjs (target version v12.7.0). Referenced when designing and implementing APIs centered on the tedious / msnodesqlv8 drivers, ConnectionPool, T-SQL execution via Request / Transaction / PreparedStatement, data types, error handling, and diagnostics.

Directory structure

skills/mssql/
  SKILL.md
  references/
    getting-started/
      README.md
      installation.md
      sql-server-prerequisites.md
      connect-string-example.md
      config-object-example.md
      windows-authentication-msnodesqlv8.md
    configuration/
      README.md
      general-options.md
      connection-string-formats.md
      azure-ad-connection-string.md
    drivers/
      README.md
      tedious.md
      msnodesqlv8.md
    connections/
      README.md
      connection-pools.md
      global-connection-pool.md
      global-pool-single-instance.md
      advanced-pool-management.md
      result-value-manipulation.md
      connection-validation.md
      events.md
      connect.md
      close.md
      pool-properties.md
      parse-connection-string.md
    requests/
      README.md
      request.md
      execute.md
      input.md
      output.md
      replace-input.md
      replace-output.md
      to-readable-stream.md
      pipe.md
      query.md
      batch.md
      bulk.md
      cancel.md
    transactions/
      README.md
      transaction.md
      begin.md
      commit.md
      rollback.md
      prepared-statement.md
      prepared-statement-input.md
      prepared-statement-output.md
      prepare.md
      prepared-statement-execute.md
      unprepare.md
    data-types-results/
      README.md
      data-types.md
      json-support.md
      geography-geometry.md
      table-valued-parameter.md
      response-schema.md
      affected-rows.md
      duplicate-column-names.md
      metadata.md
    errors-diagnostics/
      README.md
      errors.md
      error-codes.md
      detailed-sql-errors.md
      informational-messages.md
      sql-injection.md
      diagnostics-channel.md
    migration/
      README.md
      version-changes.md
  samples/
    README.md
    config.md
    async-await.md
    promises-queries.md
    promises-stored-procedures.md
    tagged-template-literals.md
    callbacks.md
    streaming.md
    global-connection-pool.md
    global-pool-single-instance.md
    advanced-pool-management.md
    transaction.md
    prepared-statement.md
    bulk-insert.md
    table-valued-parameter.md
    diagnostics-opentelemetry.md
  scripts/
    README.md
    install.md
    cli.md

Exploration procedure

Derive the category from the task, and identify the target page from the category's README.md:

1. Find the category corresponding to the task in the mapping table below
2. For that category, references/{category}/README.md to identify the target page
3. Read the .md of the relevant page to check the details

Task → Category Mapping

Task	Category	Referenced README
Want to know the installation procedure and the first steps for connecting	getting-started	references/getting-started/README.md
Want to look up connection strings and config options	configuration	references/configuration/README.md
Want to know the connection string format for Azure AD authentication	configuration	references/configuration/README.md
Want to know the differences between the tedious / msnodesqlv8 drivers and additional options	drivers	references/drivers/README.md
Want to look up ConnectionPool creation, events, and properties	connections	references/connections/README.md
Want to know about connection string parsing (parseConnectionString)	connections	references/connections/README.md
Want to know about query execution,sql.query tagged templates, and bulk insert	requests	references/requests/README.md
Want to handle input/output parameters of stored procedures	requests	references/requests/README.md
Want to handle transactions, isolation levels, and commit/rollback	transactions	references/transactions/README.md
Want to prepare and execute prepared statements	transactions	references/transactions/README.md
Want to handle SQL Server data types, TVP, and JSON/Geography results	data-types-results	references/data-types-results/README.md
Want to look up recordset / rowsAffected / metadata of query results	data-types-results	references/data-types-results/README.md
Want to know about error classes, error codes, and SQL injection countermeasures	errors-diagnostics	references/errors-diagnostics/README.md
Want to know about OpenTelemetry tracing with the Diagnostics Channel	errors-diagnostics	references/errors-diagnostics/README.md
Want to check breaking changes from older versions	migration	references/migration/README.md
Want to know typical usage	samples	samples/README.md
Want to know about installation and CLI commands	scripts	scripts/README.md