Skip to content

Commit 9222c33

Browse files
johne2021johne2021
authored
Merge pull request #20990 from David-Engel/suggestions
Address build suggestions
2 parents f0decd5 + 33f83fe commit 9222c33

2 files changed

Lines changed: 109 additions & 114 deletions

File tree

‎docs/connect/jdbc/reference/jdbc-driver-api-reference.md‎

Lines changed: 78 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: "JDBC Driver API Reference"
3-
description: "The technical API reference for the JDBC classes in the JDBC Driver for SQL Server."
2+
title: JDBC driver API reference
3+
description: The technical API reference for the JDBC classes in the JDBC Driver for SQL Server.
44
ms.custom: ""
5-
ms.date: "07/19/2018"
5+
ms.date: 01/11/2022
66
ms.prod: sql
77
ms.prod_service: connectivity
88
ms.reviewer: ""
@@ -12,103 +12,95 @@ ms.assetid: e4e1ae9d-18a6-41db-8bd2-9cf0eee4cccb
1212
author: David-Engel
1313
ms.author: v-davidengel
1414
---
15-
# JDBC Driver API Reference
15+
# JDBC driver API reference
1616

1717
[!INCLUDE[Driver_JDBC_Download](../../../includes/driver_jdbc_download.md)]
1818

19-
The [!INCLUDE[jdbcNoVersion](../../../includes/jdbcnoversion_md.md)] provides an API that can be used within Java programming code to connect to and interact with a [!INCLUDE[msCoName](../../../includes/msconame_md.md)][!INCLUDE[ssNoVersion](../../../includes/ssnoversion-md.md)] database.
20-
19+
## Overview
2120

21+
The [!INCLUDE[jdbcNoVersion](../../../includes/jdbcnoversion_md.md)] provides an API that can be used within Java programming code to connect to and interact with a [!INCLUDE[msCoName](../../../includes/msconame_md.md)][!INCLUDE[ssNoVersion](../../../includes/ssnoversion-md.md)] database.
2222

23-
### JavaDoc.io Website is Primary
23+
### JavaDoc.io website is primary
2424

2525
The Microsoft JDBC API Reference documentation is hosted for your viewing on the JavaDoc.io website. JavaDoc.io is now our primary website for JDBC reference documentation. Our JDBC reference documentation on JavaDoc.io is available at the following direct link:
2626

2727
- [https://javadoc.io/doc/com.microsoft.sqlserver/mssql-jdbc/](https://javadoc.io/doc/com.microsoft.sqlserver/mssql-jdbc/)
2828

2929
JavaDoc.io has our JDBC reference documentation starting with version 6.0.
3030

31-
#### Only Legacy JDBC Documentation is Here on Docs
32-
33-
The JDBC API Reference documentation articles here on **https://docs.microsoft.com/sql/connect/jdbc/reference/** are no longer being updated when the JDBC classes are updated for new releases. However, the articles here do contain all the reference for JDBC versions 4.1 and 4.2.
34-
35-
Documentation for JDBC version 6.0, and some later versions, is also here. But for any version 6.0 or later, use the JavaDoc.io website.
36-
37-
38-
39-
### Important Notes
40-
41-
> [!NOTE]
42-
> For conceptual information about using the JDBC driver, see [Overview of the JDBC Driver](../../../connect/jdbc/overview-of-the-jdbc-driver.md).
43-
44-
> [!IMPORTANT]
45-
> For JDBC 4.1 and 4.2 compliance support, use Microsoft JDBC Driver 4.2 (or higher) for SQL Server. The previous Microsoft JDBC Drivers 4.1 and 4.0 releases do not support new methods introduced with JDBC 4.1 or 4.2.
46-
>
47-
> API details for JDBC 4.1 compliance are not in this section. See [JDBC 4.1 Compliance for the JDBC Driver](../../../connect/jdbc/jdbc-4-1-compliance-for-the-jdbc-driver.md).
48-
>
49-
> API details for JDBC 4.2 compliance are not found in this section. See [JDBC 4.2 Compliance for the JDBC Driver](../../../connect/jdbc/jdbc-4-2-compliance-for-the-jdbc-driver.md).
50-
>
51-
> API details for Bulk Copy, available starting with Microsoft JDBC Driver 4.2 for SQL Server, are not found in this section. See [Using Bulk Copy with the JDBC Driver](../../../connect/jdbc/using-bulk-copy-with-the-jdbc-driver.md).
52-
>
53-
> API details for Always Encrypted, available starting with Microsoft JDBC Driver 6.0 for SQL Server, are not found in this section. See [Always Encrypted API Reference for the JDBC Driver](../../../connect/jdbc/always-encrypted-api-reference-for-the-jdbc-driver.md)
54-
>
55-
> API details for Using Table-Valued Parameters, available starting with Microsoft JDBC Driver 6.0 for SQL Server, are not found in this section. See [Using Table-Valued Parameters](../../../connect/jdbc/using-table-valued-parameters.md)
56-
>
57-
> Microsoft JDBC Driver 6.4 supports compilation with JDK 7.0, 8.0, and 9.0.
58-
>
59-
> Microsoft JDBC Driver 6.2 supports compilation with JDK 7.0, and 8.0.
60-
>
61-
> Microsoft JDBC Drivers 6.0 and 4.2 support compilation with JDK 5.0, 6.0, 7.0, and 8.0.
62-
>
63-
> Microsoft JDBC Driver 4.1 supports compilation with JDK 5.0, 6.0, and 7.0.
64-
65-
66-
67-
## Interfaces
68-
69-
|Interface Name|Description|
70-
|--------------------|-----------------|
71-
|[ISQLServerCallableStatement Interface](../../../connect/jdbc/reference/isqlservercallablestatement-interface.md)|Lets you specify the stored procedure name to call along with input and output parameters.|
72-
|[ISQLServerConnection Interface](../../../connect/jdbc/reference/isqlserverconnection-interface.md)|Represents a JDBC connection to a [!INCLUDE[ssNoVersion](../../../includes/ssnoversion-md.md)] database.|
73-
|[SQLServerDataSource Class](../../../connect/jdbc/reference/sqlserverdatasource-class.md)|Represents a list of properties specific to connecting to a [!INCLUDE[ssNoVersion](../../../includes/ssnoversion-md.md)] database by using a [ISQLServerConnection](../../../connect/jdbc/reference/sqlserverconnection-class.md) object.|
74-
|[ISQLServerPreparedStatement](../../../connect/jdbc/reference/isqlserverpreparedstatement-interface.md)|Represents the basic implementation of JDBC prepared statement functionality.|
75-
|[ISQLServerResultSet](../../../connect/jdbc/reference/isqlserverresultset-interface.md)|Represents a JDBC result set.|
76-
|[ISQLServerStatement](../../../connect/jdbc/reference/isqlserverstatement-interface.md)|Represents the basic implementation of JDBC statement functionality.|
31+
#### Only legacy JDBC documentation is here on docs
32+
33+
The JDBC API Reference documentation here on this website is no longer being updated. However, the articles here do contain the reference for JDBC driver versions 4.1 and 4.2.
34+
35+
Documentation for JDBC driver version 6.0, and some later versions, is also here. For any version 6.0 or later, use the [JavaDoc.io website](https://javadoc.io/doc/com.microsoft.sqlserver/mssql-jdbc/).
36+
37+
### Important notes
38+
39+
> [!NOTE]
40+
> For conceptual information about using the JDBC driver, see [Overview of the JDBC Driver](../overview-of-the-jdbc-driver.md).
41+
42+
> [!IMPORTANT]
43+
> For JDBC 4.1 and 4.2 compliance support, use Microsoft JDBC Driver 4.2 (or higher) for SQL Server. The previous Microsoft JDBC Drivers 4.1 and 4.0 releases do not support new methods introduced with JDBC 4.1 or 4.2.
44+
>
45+
> API details for JDBC 4.1 compliance are not in this section. See [JDBC 4.1 Compliance for the JDBC Driver](../jdbc-4-1-compliance-for-the-jdbc-driver.md).
46+
>
47+
> API details for JDBC 4.2 compliance are not found in this section. See [JDBC 4.2 Compliance for the JDBC Driver](../jdbc-4-2-compliance-for-the-jdbc-driver.md).
48+
>
49+
> API details for Bulk Copy, available starting with Microsoft JDBC Driver 4.2 for SQL Server, are not found in this section. See [Using Bulk Copy with the JDBC Driver](../using-bulk-copy-with-the-jdbc-driver.md).
50+
>
51+
> API details for Always Encrypted, available starting with Microsoft JDBC Driver 6.0 for SQL Server, are not found in this section. See [Always Encrypted API Reference for the JDBC Driver](../always-encrypted-api-reference-for-the-jdbc-driver.md)
52+
>
53+
> API details for Using Table-Valued Parameters, available starting with Microsoft JDBC Driver 6.0 for SQL Server, are not found in this section. See [Using Table-Valued Parameters](../using-table-valued-parameters.md)
54+
>
55+
> Microsoft JDBC Driver 6.4 supports compilation with JDK 7.0, 8.0, and 9.0.
56+
>
57+
> Microsoft JDBC Driver 6.2 supports compilation with JDK 7.0, and 8.0.
58+
>
59+
> Microsoft JDBC Drivers 6.0 and 4.2 support compilation with JDK 5.0, 6.0, 7.0, and 8.0.
60+
>
61+
> Microsoft JDBC Driver 4.1 supports compilation with JDK 5.0, 6.0, and 7.0.
62+
63+
## Interfaces
64+
65+
|Interface Name|Description|
66+
|--------------------|-----------------|
67+
|[ISQLServerCallableStatement Interface](isqlservercallablestatement-interface.md)|Lets you specify the stored procedure name to call along with input and output parameters.|
68+
|[ISQLServerConnection Interface](isqlserverconnection-interface.md)|Represents a JDBC connection to a [!INCLUDE[ssNoVersion](../../../includes/ssnoversion-md.md)] database.|
69+
|[SQLServerDataSource Class](sqlserverdatasource-class.md)|Represents a list of properties specific to connecting to a [!INCLUDE[ssNoVersion](../../../includes/ssnoversion-md.md)] database by using a [ISQLServerConnection](sqlserverconnection-class.md) object.|
70+
|[ISQLServerPreparedStatement](isqlserverpreparedstatement-interface.md)|Represents the basic implementation of JDBC prepared statement functionality.|
71+
|[ISQLServerResultSet](isqlserverresultset-interface.md)|Represents a JDBC result set.|
72+
|[ISQLServerStatement](isqlserverstatement-interface.md)|Represents the basic implementation of JDBC statement functionality.|
7773
|   |   |
7874

79-
80-
81-
## Classes
82-
83-
|Class Name|Description|
84-
|----------------|-----------------|
85-
|[DateTimeOffset](../../../connect/jdbc/reference/datetimeoffset-class.md)|Represents an object of type microsoft.sql.DateTimeOffset.|
86-
|[SQLServerBlob](../../../connect/jdbc/reference/sqlserverblob-class.md)|Represents a binary large object (BLOB).|
87-
|[SQLServerCallableStatement](../../../connect/jdbc/reference/sqlservercallablestatement-class.md)|Implements ISQLServerCallableStatement.|
88-
|[SQLServerClob](../../../connect/jdbc/reference/sqlserverclob-class.md)|Represents a character large binary object (CLOB).|
89-
|[SQLServerConnection](../../../connect/jdbc/reference/sqlserverconnection-class.md)|Implements ISQLServerConnectopn.|
90-
|[SQLServerConnectionPoolDataSource](../../../connect/jdbc/reference/sqlserverconnectionpooldatasource-class.md)|Represents physical database connections for connection pool managers.|
91-
|[SQLServerDatabaseMetaData](../../../connect/jdbc/reference/sqlserverdatabasemetadata-class.md)|Represents the metadata for the database.|
92-
|[SQLServerDataSource](../../../connect/jdbc/reference/isqlserverdatasource-interface.md)|Represents a list of properties specific to connecting to a [!INCLUDE[ssNoVersion](../../../includes/ssnoversion-md.md)] database by using a [SQLServerConnection](../../../connect/jdbc/reference/sqlserverconnection-class.md) object.|
93-
|[SQLServerDataSourceObjectFactory](../../../connect/jdbc/reference/sqlserverdatasourceobjectfactory-class.md)|Represents an object factory to materialize data sources from the Java Naming and Directory Interface (JNDI).|
94-
|[SQLServerDriver](../../../connect/jdbc/reference/sqlserverdriver-class.md)|Represents the JDBC driver. This class includes methods for connecting to a [!INCLUDE[ssNoVersion](../../../includes/ssnoversion-md.md)] database, and for obtaining information about the JDBC driver.|
95-
|[SQLServerException](../../../connect/jdbc/reference/sqlserverexception-class.md)|Represents an unsuccessful or incomplete running of an SQL statement.|
96-
|[SQLServerNClob Class](../../../connect/jdbc/reference/sqlservernclob-class.md)|Represents a character large binary object using the National Character Set.|
97-
|[SQLServerParameterMetaData](../../../connect/jdbc/reference/sqlserverparametermetadata-class.md)|Represents the metadata for prepared statement parameters.|
98-
|[SQLServerPooledConnection](../../../connect/jdbc/reference/sqlserverpooledconnection-class.md)|Represents a physical database connection in a connection pool.|
99-
|[SQLServerPreparedStatement](../../../connect/jdbc/reference/sqlserverpreparedstatement-class.md)|Implements ISQLServerPreparedStatement.|
100-
|[SQLServerResource](../../../connect/jdbc/reference/sqlserverresource-class.md)|Represents a localized error string resource. This class is intended for internal use only.|
101-
|[SQLServerResultSet](../../../connect/jdbc/reference/sqlserverresultset-class.md)|Implements ISQLServerResultSet.|
102-
|[SQLServerResultSetMetaData](../../../connect/jdbc/reference/sqlserverresultsetmetadata-class.md)|Represents the metadata of the columns that are contained within a result set.|
103-
|[SQLServerSavepoint](../../../connect/jdbc/reference/sqlserversavepoint-class.md)|Represents the checkpoint to which a transaction can be rolled back.|
104-
|[SQLServerStatement](../../../connect/jdbc/reference/sqlserverstatement-class.md)|Implements ISQLServerStatement.|
105-
|[SQLServerXAConnection](../../../connect/jdbc/reference/sqlserverxaconnection-class.md)|Represents JDBC connections that can participate in distributed (XA) transactions.|
106-
|[SQLServerXADataSource](../../../connect/jdbc/reference/sqlserverxadatasource-class.md)|Represents a factory for [SQLServerXAConnection](../../../connect/jdbc/reference/sqlserverxaconnection-class.md) objects that is used internally.|
107-
|[SQLServerXAResource](../../../connect/jdbc/reference/sqlserverxaresource-class.md)|Represents an XAResource for XA distributed transaction management.|
75+
## Classes
76+
77+
|Class Name|Description|
78+
|----------------|-----------------|
79+
|[DateTimeOffset](datetimeoffset-class.md)|Represents an object of type microsoft.sql.DateTimeOffset.|
80+
|[SQLServerBlob](sqlserverblob-class.md)|Represents a binary large object (BLOB).|
81+
|[SQLServerCallableStatement](sqlservercallablestatement-class.md)|Implements ISQLServerCallableStatement.|
82+
|[SQLServerClob](sqlserverclob-class.md)|Represents a character large binary object (CLOB).|
83+
|[SQLServerConnection](sqlserverconnection-class.md)|Implements ISQLServerConnectopn.|
84+
|[SQLServerConnectionPoolDataSource](sqlserverconnectionpooldatasource-class.md)|Represents physical database connections for connection pool managers.|
85+
|[SQLServerDatabaseMetaData](sqlserverdatabasemetadata-class.md)|Represents the metadata for the database.|
86+
|[SQLServerDataSource](isqlserverdatasource-interface.md)|Represents a list of properties specific to connecting to a [!INCLUDE[ssNoVersion](../../../includes/ssnoversion-md.md)] database by using a [SQLServerConnection](sqlserverconnection-class.md) object.|
87+
|[SQLServerDataSourceObjectFactory](sqlserverdatasourceobjectfactory-class.md)|Represents an object factory to materialize data sources from the Java Naming and Directory Interface (JNDI).|
88+
|[SQLServerDriver](sqlserverdriver-class.md)|Represents the JDBC driver. This class includes methods for connecting to a [!INCLUDE[ssNoVersion](../../../includes/ssnoversion-md.md)] database, and for obtaining information about the JDBC driver.|
89+
|[SQLServerException](sqlserverexception-class.md)|Represents an unsuccessful or incomplete running of an SQL statement.|
90+
|[SQLServerNClob Class](sqlservernclob-class.md)|Represents a character large binary object using the National Character Set.|
91+
|[SQLServerParameterMetaData](sqlserverparametermetadata-class.md)|Represents the metadata for prepared statement parameters.|
92+
|[SQLServerPooledConnection](sqlserverpooledconnection-class.md)|Represents a physical database connection in a connection pool.|
93+
|[SQLServerPreparedStatement](sqlserverpreparedstatement-class.md)|Implements ISQLServerPreparedStatement.|
94+
|[SQLServerResource](sqlserverresource-class.md)|Represents a localized error string resource. This class is intended for internal use only.|
95+
|[SQLServerResultSet](sqlserverresultset-class.md)|Implements ISQLServerResultSet.|
96+
|[SQLServerResultSetMetaData](sqlserverresultsetmetadata-class.md)|Represents the metadata of the columns that are contained within a result set.|
97+
|[SQLServerSavepoint](sqlserversavepoint-class.md)|Represents the checkpoint to which a transaction can be rolled back.|
98+
|[SQLServerStatement](sqlserverstatement-class.md)|Implements ISQLServerStatement.|
99+
|[SQLServerXAConnection](sqlserverxaconnection-class.md)|Represents JDBC connections that can participate in distributed (XA) transactions.|
100+
|[SQLServerXADataSource](sqlserverxadatasource-class.md)|Represents a factory for [SQLServerXAConnection](sqlserverxaconnection-class.md) objects that is used internally.|
101+
|[SQLServerXAResource](sqlserverxaresource-class.md)|Represents an XAResource for XA distributed transaction management.|
108102
|   |   |
109103

104+
## See also
110105

111-
112-
## See Also
113-
[Overview of the JDBC Driver](../../../connect/jdbc/overview-of-the-jdbc-driver.md)
114-
106+
[Overview of the JDBC driver](../overview-of-the-jdbc-driver.md)

‎docs/connect/jdbc/reference/supportsansi92intermediatesql-method-sqlserverdatabasemetadata.md‎

Lines changed: 31 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,48 @@
11
---
2-
title: "supportsANSI92IntermediateSQL Method (SQLServerDatabaseMetaData) | Microsoft Docs"
2+
title: supportsANSI92IntermediateSQL Method (SQLServerDatabaseMetaData)
3+
description: "API reference for the mssql-jdbc library. Method: supportsANSI92IntermediateSQL (SQLServerDatabaseMetaData)"
34
ms.custom: ""
4-
ms.date: "01/19/2017"
5+
ms.date: 01/11/2022
56
ms.prod: sql
67
ms.prod_service: connectivity
78
ms.reviewer: ""
89
ms.technology: connectivity
910
ms.topic: reference
10-
apiname:
11+
apiname:
1112
- "SQLServerDatabaseMetaData.supportsANSI92IntermediateSQL"
12-
apilocation:
13+
apilocation:
1314
- "sqljdbc.jar"
1415
apitype: "Assembly"
1516
ms.assetid: 4d6e8301-0633-4565-91c6-a80910954461
1617
author: David-Engel
1718
ms.author: v-davidengel
1819
---
1920
# supportsANSI92IntermediateSQL Method (SQLServerDatabaseMetaData)
21+
2022
[!INCLUDE[Driver_JDBC_Download](../../../includes/driver_jdbc_download.md)]
2123

22-
Retrieves whether this database supports the ANSI92 intermediate SQL grammar.
23-
24-
## Syntax
25-
26-
```
27-
28-
public boolean supportsANSI92IntermediateSQL()
29-
```
30-
31-
## Return Value
32-
**true** if supported. Otherwise, **false**.
33-
34-
## Exceptions
35-
[SQLServerException](../../../connect/jdbc/reference/sqlserverexception-class.md)
36-
37-
## Remarks
38-
This supportsANSI92IntermediateSQL method is specified by the supportsANSI92IntermediateSQL method in the java.sql.DatabaseMetaData interface.
39-
40-
## See Also
41-
[SQLServerDatabaseMetaData Methods](../../../connect/jdbc/reference/sqlserverdatabasemetadata-methods.md)
42-
[SQLServerDatabaseMetaData Members](../../../connect/jdbc/reference/sqlserverdatabasemetadata-members.md)
43-
[SQLServerDatabaseMetaData Class](../../../connect/jdbc/reference/sqlserverdatabasemetadata-class.md)
44-
45-
24+
Retrieves whether this database supports the ANSI92 intermediate SQL grammar.
25+
26+
## Syntax
27+
28+
```java
29+
public boolean supportsANSI92IntermediateSQL()
30+
```
31+
32+
## Return value
33+
34+
**true** if supported. Otherwise, **false**.
35+
36+
## Exceptions
37+
38+
[SQLServerException](sqlserverexception-class.md)
39+
40+
## Remarks
41+
42+
This supportsANSI92IntermediateSQL method is specified by the supportsANSI92IntermediateSQL method in the java.sql.DatabaseMetaData interface.
43+
44+
## See also
45+
46+
[SQLServerDatabaseMetaData Methods](sqlserverdatabasemetadata-methods.md)
47+
[SQLServerDatabaseMetaData Members](sqlserverdatabasemetadata-members.md)
48+
[SQLServerDatabaseMetaData Class](sqlserverdatabasemetadata-class.md)

0 commit comments

Comments
 (0)