Share via


Invoke-AzureHDInsightHiveJob

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Invoke-AzureHDInsightHiveJob

Submits Hive queries to the HDInsight cluster, shows progress of the query execution, and retrieves query results in one operation.

Syntax

Parameter Set: Default
Invoke-AzureHDInsightHiveJob [[-Query] <String> ] [-Arguments <String[]> ] [-Defines <Hashtable> ] [-File <String> ] [-Files <String[]> ] [-JobName <String> ] [-StatusFolder <String> ] [ <CommonParameters>]

Detailed Description

Submits Hive queries to the HDInsight cluster, shows progress of the query execution, and retrieves query results in one operation. The Use-AzureHDInsightCluster cmdlet needs to be used before calling Invoke-Hive to specify which HDInsight cluster the query will be submitted to.

This topic describes the cmdlet in the 0.8.1 version of the Microsoft Azure PowerShell module. To find out the version of the module you're using, from the Azure PowerShell console, type (get-module azure).version.

Parameters

-Arguments<String[]>

Arguments of the Hadoop job. The arguments will be passed as command line arguments to each task.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Defines<Hashtable>

Hadoop configuration values to be set during the job execution.

Aliases

Params

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-File<String>

The wasb path to a file in Azure Blob Storage that contains the query to be executed. Use this File parameter in place of a query parameter.

Aliases

QueryFile

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Files<String[]>

A collection of files required for the Hive job to execute.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-JobName<String>

The name of the Hive job being defined. If the name is not specified, it is "Hive: <first 100 characters of Query>" by default.

Aliases

Name

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Query<String>

The Hive query to be executed.

Aliases

QueryText

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-StatusFolder<String>

Location of the status folder where the standard and error outputs of the job will be stored, including its exit code and task logs.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see  about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Submit a Hive query

Submit a Hive queries to the HDInsight cluster.

PS C:\> Use-AzureHDInsightCluster yourcluster 
Invoke-Hive "select * from hivesampletable limit 10"