Skip to content

Commit 5511948

Browse files
committed
address suggestions
1 parent c9529d6 commit 5511948

2 files changed

Lines changed: 24 additions & 25 deletions

File tree

docs/relational-databases/native-client-odbc-date-time/odbc-api-support-for-enhanced-date-and-time-features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ helpviewer_keywords:
1111
- "date/time [ODBC], API support"
1212
---
1313

14-
## ODBC API support for enhanced date and time features
14+
# ODBC API support for enhanced date and time features
1515

1616
[!INCLUDE [SQL Server Azure SQL Database Synapse Analytics PDW](../../includes/applies-to-version/sql-asdb-asdbmi-asa-pdw.md)]
1717

docs/relational-databases/native-client-odbc-table-valued-parameters/odbc-table-valued-parameter-api-summary.md

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -16,61 +16,60 @@ helpviewer_keywords:
1616

1717
[!INCLUDE [SQL Server Azure SQL Database Synapse Analytics PDW](../../includes/applies-to-version/sql-asdb-asdbmi-asa-pdw.md)]
1818

19-
ODBC supports table-valued parameters (TVPs) through enhancements to several existing API functions. These functions work together to describe TVP schemas, bind and transmit row sets, fetch metadata, and manage descriptor records.
20-
The following sections organize the relevant ODBC functions into logical groups to help you understand how each part of the TVP pipeline operates.
19+
ODBC supports table-valued parameters (table‑valued parameters) through enhancements to several existing API functions. These functions work together to describe table‑valued parameter schemas, bind and transmit row sets, fetch metadata, and manage descriptor records.
20+
The following sections organize the relevant ODBC functions into logical groups to help you understand how each part of the table‑valued parameter pipeline operates.
2121

22-
## TVP schema discovery and metadata functions
22+
## Table‑valued parameter schema discovery and metadata functions
2323

2424
These functions help an application discover the structure of table-valued parameters, including column metadata, parameter definitions, and available SQL data types.
2525

2626
| Function | Purpose |
2727
|----------|----------|
2828
| [SQLColumns](../../relational-databases/native-client-odbc-api/sqlcolumns.md) | Retrieves column metadata for a table‑valued parameter or table type. |
29-
| [SQLDescribeParam](../../relational-databases/native-client-odbc-api/sqldescribeparam.md) | Returns metadata for a TVP parameter, including type, precision, and scale. |
29+
| [SQLDescribeParam](../../relational-databases/native-client-odbc-api/sqldescribeparam.md) | Returns metadata for a table‑valued parameter parameter, including type, precision, and scale. |
3030
| [SQLGetTypeInfo](../../relational-databases/native-client-odbc-api/sqlgettypeinfo.md) | Retrieves the SQL data types supported by the driver for table‑valued parameter columns. |
31-
| [SQLPrimaryKeys](../../relational-databases/native-client-odbc-api/sqlprimarykeys.md) | Provides information about key columns in table types used with TVPs. |
32-
| [SQLProcedureColumns](../../relational-databases/native-client-odbc-api/sqlprocedurecolumns.md) | Retrieves metadata for TVP-related stored procedure parameters. |
33-
| [SQLTables](../../relational-databases/native-client-odbc-api/sqltables.md) | Lists tables and table types available as sources for TVP declarations. |
31+
| [SQLPrimaryKeys](../../relational-databases/native-client-odbc-api/sqlprimarykeys.md) | Provides information about key columns in table types used with table‑valued parameters. |
32+
| [SQLProcedureColumns](../../relational-databases/native-client-odbc-api/sqlprocedurecolumns.md) | Retrieves metadata for table‑valued parameter-related stored procedure parameters. |
33+
| [SQLTables](../../relational-databases/native-client-odbc-api/sqltables.md) | Lists tables and table types available as sources for table‑valued parameter declarations. |
3434

35-
## TVP parameter binding and data transmission
35+
## Table‑valued parameter parameter binding and data transmission
3636

3737
These functions handle binding structured data to parameters, passing the data to the server, or streaming rows during execution.
3838

3939
| Function | Purpose |
4040
|----------|---------|
4141
| [SQLBindParameter](../../relational-databases/native-client-odbc-api/sqlbindparameter.md) | Binds a table-valued parameter to an application buffer or rowset. |
42-
| [SQLParamData](../../relational-databases/native-client-odbc-api/sqlparamdata.md) | Retrieves the next part of a streamed TVP parameter when using data-at-execution. |
43-
| [SQLPutData](../../relational-databases/native-client-odbc-api/sqlputdata.md) | Sends TVP data in chunks during data-at-execution operations. |
42+
| [SQLParamData](../../relational-databases/native-client-odbc-api/sqlparamdata.md) | Retrieves the next part of a streamed table‑valued parameter parameter when using data-at-execution. |
43+
| [SQLPutData](../../relational-databases/native-client-odbc-api/sqlputdata.md) | Sends table‑valued parameter data in chunks during data-at-execution operations. |
4444

45-
## Statement execution for TVPs
45+
## Statement execution for table‑valued parameters
4646

47-
These functions execute SQL statements that reference TVPs and manage the execution lifecycle.
47+
These functions execute SQL statements that reference table‑valued parameters and manage the execution lifecycle.
4848

4949
| Function | Purpose |
5050
|----------|---------|
51-
| [SQLExecDirect](../../relational-databases/native-client-odbc-api/sqlexecdirect.md) | Executes a SQL statement that uses TVPs without preparing it first. |
52-
| [SQLExecute](../../relational-databases/native-client-odbc-api/sqlexecute.md) | Executes a previously prepared SQL statement that includes TVP parameters. |
51+
| [SQLExecDirect](../../relational-databases/native-client-odbc-api/sqlexecdirect.md) | Executes a SQL statement that uses table‑valued parameters without preparing it first. |
52+
| [SQLExecute](../../relational-databases/native-client-odbc-api/sqlexecute.md) | Executes a previously prepared SQL statement that includes table‑valued parameter parameters. |
5353

54-
## Descriptor and attribute management for TVPs
54+
## Descriptor and attribute management for table‑valued parameters
5555

5656
Use these functions to manage descriptor fields and statement attributes required to describe rowsets and structured parameters correctly.
5757

5858
| Function | Purpose |
5959
|----------|---------|
60-
| [SQLGetDescField](../../relational-databases/native-client-odbc-api/sqlgetdescfield.md) | Retrieves descriptor metadata for TVP columns or rowsets. |
61-
| [SQLGetDescRec](../../relational-databases/native-databases/native-client-odbc-api/sqlgetdescrec.md) | Retrieves a complete descriptor record for a TVP. |
62-
| [SQLSetDescField](../../relational-databases/native-client-odbc-api/sqlsetdescfield.md) | Sets descriptor metadata for TVP columns or rowsets. |
63-
| [SQLSetDescRec](../../relational-databases/native-client-odbc-api/sqlsetdescrec.md) | Sets a full descriptor record for structured TVP data. |
64-
| [SQLGetStmtAttr](../../relational-databases/native-client-odbc-api/sqlgetstmtattr.md) | Retrieves statement attributes affecting TVP execution behavior. |
65-
| [SQLSetStmtAttr](../../relational-databases/native-client-odbc-api/sqlsetstmtattr.md) | Sets statement attributes such as rowset sizes or streaming flags for TVP operations. |
60+
| [SQLGetDescField](../../relational-databases/native-client-odbc-api/sqlgetdescfield.md) | Retrieves descriptor metadata for table‑valued parameter columns or rowsets. |
61+
| [SQLSetDescField](../../relational-databases/native-client-odbc-api/sqlsetdescfield.md) | Sets descriptor metadata for table‑valued parameter columns or rowsets. |
62+
| [SQLSetDescRec](../../relational-databases/native-client-odbc-api/sqlsetdescrec.md) | Sets a full descriptor record for structured table‑valued parameter data. |
63+
| [SQLGetStmtAttr](../../relational-databases/native-client-odbc-api/sqlgetstmtattr.md) | Retrieves statement attributes affecting table‑valued parameter execution behavior. |
64+
| [SQLSetStmtAttr](../../relational-databases/native-client-odbc-api/sqlsetstmtattr.md) | Sets statement attributes such as rowset sizes or streaming flags for table‑valued parameter operations. |
6665

67-
## Diagnostics and error handling for TVPs
66+
## Diagnostics and error handling for table‑valued parameters
6867

69-
Use these functions to help your applications detect errors, warnings, or status messages during TVP binding and execution.
68+
Use these functions to help your applications detect errors, warnings, or status messages during table‑valued parameter binding and execution.
7069

7170
| Function | Purpose |
7271
|----------|---------|
73-
| [SQLGetDiagField](../../relational-databases/native-client-odbc-api/sqlgetdiagfield.md) | Retrieves diagnostic information generated during TVP processing. |
72+
| [SQLGetDiagField](../../relational-databases/native-client-odbc-api/sqlgetdiagfield.md) | Retrieves diagnostic information generated during table‑valued parameter processing. |
7473

7574
## Related content
7675

0 commit comments

Comments
 (0)