Skip to content

Commit b992e52

Browse files
PMEds28PMEds28
authored
Merge pull request #17628 from icoric/icoric-patch-14
Adding 'unsupported syntax' note for Synapse Analytics SQL OnDemand
2 parents 02c9000 + cf30828 commit b992e52

17 files changed

Lines changed: 94 additions & 87 deletions

‎docs/relational-databases/system-stored-procedures/sp-pdw-add-network-credentials-sql-data-warehouse.md‎

Lines changed: 79 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,79 @@
1-
---
2-
description: "sp_pdw_add_network_credentials (Azure Synapse Analytics)"
3-
title: "sp_pdw_add_network_credentials"
4-
titleSuffix: Azure Synapse Analytics
5-
ms.date: "03/14/2017"
6-
ms.service: sql-data-warehouse
7-
ms.reviewer: ""
8-
ms.topic: "language-reference"
9-
dev_langs:
10-
- "TSQL"
11-
ms.assetid: 0729eeff-ac7e-43f0-80fa-ff5346a75985
12-
author: ronortloff
13-
ms.author: rortloff
14-
monikerRange: ">= aps-pdw-2016 || = azure-sqldw-latest || = sqlallproducts-allversions"
15-
ms.custom: seo-dt-2019
16-
---
17-
# sp_pdw_add_network_credentials (Azure Synapse Analytics)
18-
[!INCLUDE[applies-to-version/asa-pdw](../../includes/applies-to-version/asa-pdw.md)]
19-
20-
This stores network credentials in [!INCLUDE[ssSDW](../../includes/sssdw-md.md)] and associates them with a server. For example, use this stored procedure to give [!INCLUDE[ssSDW](../../includes/sssdw-md.md)] appropriate read/write permissions to perform database backup and restore operations on a target server, or to create a backup of a certificate used for TDE.
21-
22-
![Topic link icon](../../database-engine/configure-windows/media/topic-link.gif "Topic link icon") [Transact-SQL Syntax Conventions (Transact-SQL)](../../t-sql/language-elements/transact-sql-syntax-conventions-transact-sql.md)
23-
24-
## Syntax
25-
26-
```syntaxsql
27-
-- Syntax for Azure Synapse Analytics and Parallel Data Warehouse
28-
29-
sp_pdw_add_network_credentials 'target_server_name', 'user_name', 'password'
30-
```
31-
32-
[!INCLUDE[synapse-analytics-od-unsupported-syntax](../../includes/synapse-analytics-od-unsupported-syntax.md)]
33-
34-
## Arguments
35-
'*target_server_name*'
36-
Specifies the target server host name or IP address. [!INCLUDE[ssSDW](../../includes/sssdw-md.md)] will access this server by using the username and password credentials passed to this stored procedure.
37-
38-
To connect through the InfiniBand network, use the InfiniBand IP address of the target server.
39-
40-
*target_server_name* is defined as nvarchar(337).
41-
42-
'*user_name*'
43-
Specifies the user_name that has permissions to access the target server. If credentials already exist for the target server, they will be updated to the new credentials.
44-
45-
*user_name* is defined as nvarchar (513).
46-
47-
'*password*ꞌ
48-
Specifies the password for *user_name*.
49-
50-
## Return Code Values
51-
0 (success) or 1 (failure)
52-
53-
## Permissions
54-
Requires **ALTER SERVER STATE** permission.
55-
56-
## Error Handling
57-
An error occurs if adding credentials does not succeed on the Control node and all Compute nodes.
58-
59-
## General Remarks
60-
This stored procedure adds network credentials to the NetworkService account for [!INCLUDE[ssSDW](../../includes/sssdw-md.md)]. The NetworkService account runs each instance of SMP [!INCLUDE[ssNoVersion](../../includes/ssnoversion-md.md)] on the Control node and the Compute nodes. For example, when a backup operation runs, the Control node and each Compute node will use the NetworkService account credentials to gain read and write permission to the target server.
61-
62-
## Examples: [!INCLUDE[ssSDWfull](../../includes/sssdwfull-md.md)] and [!INCLUDE[ssPDW](../../includes/sspdw-md.md)]
63-
64-
### A. Add credentials for performing a database backup
65-
The following example associates the user name and password credentials for the domain user seattle\david with a target server that has an IP address of 10.172.63.255. The user seattle\david has read/write permissions to the target server. [!INCLUDE[ssSDW](../../includes/sssdw-md.md)] will store these credentials and use them to read and write to and from the target server, as necessary for backup and restore operations.
66-
67-
```sql
68-
EXEC sp_pdw_add_network_credentials '10.172.63.255', 'seattle\david', '********';
69-
```
70-
71-
The backup command requires that the server name be entered as an IP address.
72-
73-
> [!NOTE]
74-
> To perform the database backup over InfiniBand, be sure to use the InfiniBand IP address of the backup server.
75-
76-
## See Also
77-
[sp_pdw_remove_network_credentials (Azure Synapse Analytics)](../../relational-databases/system-stored-procedures/sp-pdw-remove-network-credentials-sql-data-warehouse.md)
78-
79-
80-
1+
---
2+
description: "sp_pdw_add_network_credentials (Azure Synapse Analytics)"
3+
title: "sp_pdw_add_network_credentials"
4+
titleSuffix: Azure Synapse Analytics
5+
ms.date: "03/14/2017"
6+
ms.service: sql-data-warehouse
7+
ms.reviewer: ""
8+
ms.topic: "language-reference"
9+
dev_langs:
10+
- "TSQL"
11+
ms.assetid: 0729eeff-ac7e-43f0-80fa-ff5346a75985
12+
author: ronortloff
13+
ms.author: rortloff
14+
monikerRange: ">= aps-pdw-2016 || = azure-sqldw-latest || = sqlallproducts-allversions"
15+
ms.custom: seo-dt-2019
16+
---
17+
# sp_pdw_add_network_credentials (Azure Synapse Analytics)
18+
[!INCLUDE[applies-to-version/asa-pdw](../../includes/applies-to-version/asa-pdw.md)]
19+
20+
This stores network credentials in [!INCLUDE[ssSDW](../../includes/sssdw-md.md)] and associates them with a server. For example, use this stored procedure to give [!INCLUDE[ssSDW](../../includes/sssdw-md.md)] appropriate read/write permissions to perform database backup and restore operations on a target server, or to create a backup of a certificate used for TDE.
21+
22+
![Topic link icon](../../database-engine/configure-windows/media/topic-link.gif "Topic link icon") [Transact-SQL Syntax Conventions (Transact-SQL)](../../t-sql/language-elements/transact-sql-syntax-conventions-transact-sql.md)
23+
24+
## Syntax
25+
26+
```syntaxsql
27+
-- Syntax for Azure Synapse Analytics and Parallel Data Warehouse
28+
29+
sp_pdw_add_network_credentials 'target_server_name', 'user_name', 'password'
30+
```
31+
[!INCLUDE[synapse-analytics-od-unsupported-syntax](../../includes/synapse-analytics-od-unsupported-syntax.md)]
32+
33+
## Arguments
34+
'*target_server_name*'
35+
Specifies the target server host name or IP address. [!INCLUDE[ssSDW](../../includes/sssdw-md.md)] will access this server by using the username and password credentials passed to this stored procedure.
36+
37+
To connect through the InfiniBand network, use the InfiniBand IP address of the target server.
38+
39+
*target_server_name* is defined as nvarchar(337).
40+
41+
'*user_name*'
42+
Specifies the user_name that has permissions to access the target server. If credentials already exist for the target server, they will be updated to the new credentials.
43+
44+
*user_name* is defined as nvarchar (513).
45+
46+
'*password*ꞌ
47+
Specifies the password for *user_name*.
48+
49+
## Return Code Values
50+
0 (success) or 1 (failure)
51+
52+
## Permissions
53+
Requires **ALTER SERVER STATE** permission.
54+
55+
## Error Handling
56+
An error occurs if adding credentials does not succeed on the Control node and all Compute nodes.
57+
58+
## General Remarks
59+
This stored procedure adds network credentials to the NetworkService account for [!INCLUDE[ssSDW](../../includes/sssdw-md.md)]. The NetworkService account runs each instance of SMP [!INCLUDE[ssNoVersion](../../includes/ssnoversion-md.md)] on the Control node and the Compute nodes. For example, when a backup operation runs, the Control node and each Compute node will use the NetworkService account credentials to gain read and write permission to the target server.
60+
61+
## Examples: [!INCLUDE[ssSDWfull](../../includes/sssdwfull-md.md)] and [!INCLUDE[ssPDW](../../includes/sspdw-md.md)]
62+
63+
### A. Add credentials for performing a database backup
64+
The following example associates the user name and password credentials for the domain user seattle\david with a target server that has an IP address of 10.172.63.255. The user seattle\david has read/write permissions to the target server. [!INCLUDE[ssSDW](../../includes/sssdw-md.md)] will store these credentials and use them to read and write to and from the target server, as necessary for backup and restore operations.
65+
66+
```sql
67+
EXEC sp_pdw_add_network_credentials '10.172.63.255', 'seattle\david', '********';
68+
```
69+
70+
The backup command requires that the server name be entered as an IP address.
71+
72+
> [!NOTE]
73+
> To perform the database backup over InfiniBand, be sure to use the InfiniBand IP address of the backup server.
74+
75+
## See Also
76+
[sp_pdw_remove_network_credentials (Azure Synapse Analytics)](../../relational-databases/system-stored-procedures/sp-pdw-remove-network-credentials-sql-data-warehouse.md)
77+
78+
79+

‎docs/relational-databases/system-stored-procedures/sp-spaceused-transact-sql.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ sp_spaceused [[ @objname = ] 'objname' ]
3636
[, [ @oneresultset = ] oneresultset ]
3737
[, [ @include_total_xtp_storage = ] include_total_xtp_storage ]
3838
```
39+
[!INCLUDE[synapse-analytics-od-unsupported-syntax](../../includes/synapse-analytics-od-unsupported-syntax.md)]
3940

4041
## Arguments
4142

‎docs/t-sql/functions/checksum-transact-sql.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ CHECKSUM ( * | expression [ ,...n ] )
3737
```
3838

3939
[!INCLUDE[sql-server-tsql-previous-offline-documentation](../../includes/sql-server-tsql-previous-offline-documentation.md)]
40+
[!INCLUDE[synapse-analytics-od-unsupported-syntax](../../includes/synapse-analytics-od-unsupported-syntax.md)]
4041

4142
## Arguments
4243
\*

‎docs/t-sql/language-elements/set-local-variable-transact-sql.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ SET
5757
```
5858
Syntax for Azure Synapse Analytics and Parallel Data Warehouse:
5959
```syntaxsql
60-
SET @local_variable {+= | -= | *= | /= | %= | &= | ^= | |= } expression
60+
SET @local_variable { = | += | -= | *= | /= | %= | &= | ^= | |= } expression
6161
```
6262

6363
[!INCLUDE[sql-server-tsql-previous-offline-documentation](../../includes/sql-server-tsql-previous-offline-documentation.md)]

‎docs/t-sql/statements/alter-authorization-transact-sql.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,7 @@ ALTER AUTHORIZATION ON
115115
| [ schema_name. ] object_name
116116
}
117117
```
118+
[!INCLUDE[synapse-analytics-od-unsupported-syntax](../../includes/synapse-analytics-od-unsupported-syntax.md)]
118119

119120
[!INCLUDE[sql-server-tsql-previous-offline-documentation](../../includes/sql-server-tsql-previous-offline-documentation.md)]
120121

‎docs/t-sql/statements/alter-certificate-transact-sql.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ ALTER CERTIFICATE certificate_name
7070
DECRYPTION BY PASSWORD = '<key password>' )
7171
}
7272
```
73-
73+
[!INCLUDE[synapse-analytics-od-unsupported-syntax](../../includes/synapse-analytics-od-unsupported-syntax.md)]
7474

7575
[!INCLUDE[sql-server-tsql-previous-offline-documentation](../../includes/sql-server-tsql-previous-offline-documentation.md)]
7676

‎docs/t-sql/statements/alter-database-encryption-key-transact-sql.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ ALTER DATABASE ENCRYPTION KEY
6060
}
6161
[ ; ]
6262
```
63+
[!INCLUDE[synapse-analytics-od-unsupported-syntax](../../includes/synapse-analytics-od-unsupported-syntax.md)]
6364

6465
[!INCLUDE[sql-server-tsql-previous-offline-documentation](../../includes/sql-server-tsql-previous-offline-documentation.md)]
6566

‎docs/t-sql/statements/alter-materialized-view-transact-sql.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@ ALTER MATERIALIZED VIEW [ schema_name . ] view_name
3939
}
4040
[;]
4141
```
42-
4342
[!INCLUDE[synapse-analytics-od-unsupported-syntax](../../includes/synapse-analytics-od-unsupported-syntax.md)]
4443

4544
## Arguments

‎docs/t-sql/statements/backup-certificate-transact-sql.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ BACKUP CERTIFICATE certname TO FILE ='path_to_file'
6565
ENCRYPTION BY PASSWORD ='encryption_password'
6666
)
6767
```
68+
[!INCLUDE[synapse-analytics-od-unsupported-syntax](../../includes/synapse-analytics-od-unsupported-syntax.md)]
6869

6970
[!INCLUDE[sql-server-tsql-previous-offline-documentation](../../includes/sql-server-tsql-previous-offline-documentation.md)]
7071

‎docs/t-sql/statements/create-certificate-transact-sql.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ CREATE CERTIFICATE certificate_name
106106
<date_options> ::=
107107
START_DATE ='datetime' | EXPIRY_DATE ='datetime'
108108
```
109+
[!INCLUDE[synapse-analytics-od-unsupported-syntax](../../includes/synapse-analytics-od-unsupported-syntax.md)]
109110

110111
[!INCLUDE[sql-server-tsql-previous-offline-documentation](../../includes/sql-server-tsql-previous-offline-documentation.md)]
111112

0 commit comments

Comments
 (0)