Skip to content

Latest commit

 

History

History
82 lines (56 loc) · 2.88 KB

polybase-stored-procedures-sp-polybase-join-group.md

File metadata and controls

82 lines (56 loc) · 2.88 KB
title description author ms.author ms.reviewer ms.date ms.service ms.subservice ms.topic f1_keywords helpviewer_keywords dev_langs
sp_polybase_join_group
Adds a SQL Server instance as a compute node to a PolyBase group for scale-out computation.
markingmyname
maghan
randolphwest
03/07/2025
sql
system-objects
conceptual
sp_polybase_join_group
PolyBase
TSQL

sp_polybase_join_group (Transact-SQL)

[!INCLUDE sqlserver2016]

Adds a SQL Server instance as a compute node to a PolyBase group for scale-out computation.

The SQL Server instance must have the PolyBase feature installed. PolyBase enables the integration of non-SQL Server data sources, such as Hadoop and Azure Blob Storage. See also sp_polybase_leave_group.

:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: Transact-SQL syntax conventions

Syntax

sp_polybase_join_group (
    @head_node_address = N'head_node_address'
    , @dms_control_channel_port = dms_control_channel_port
    , @head_node_sql_server_instance_name = 'head_node_sql_server_instance_name'
    )
[ ; ]

Arguments

[!INCLUDE extended-stored-procedures]

@head_node_address = N'head_node_address'

The name of the machine that hosts the SQL Server head node of the PolyBase scale-out group. @head_node_address is nvarchar(255).

@dms_control_channel_port = dms_control_channel_port

The port where the control channel for the head node PolyBase Data Movement Service is running. @dms_control_channel_port is an unsigned __int16, with a range of 0 to 65535. The default is 16450.

@head_node_sql_server_instance_name = N'head_node_sql_server_instance_name'

The name of the head node SQL Server instance in the PolyBase scale-out group. @head_node_sql_server_instance_name is nvarchar(16).

Return code values

0 (success) or 1 (failure).

Permissions

Requires CONTROL SERVER permission.

Remarks

After running the stored procedure, shut down the PolyBase engine, and restart the PolyBase Data Movement Service on the machine. To verify, run the following DMV on the head node:

EXEC sys.dm_exec_compute_nodes;

Examples

The example joins the current machine as a compute node to a PolyBase group. The name of the head node is HST01 and the name of the SQL Server instance on the head node is MSSQLSERVER.

EXEC sp_polybase_join_group N'HST01', 16450, N'MSSQLSERVER';

Related content