Kelverion.Oracle.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <!--Edited with: SAPIEN PowerShell HelpWriter 2018 v2.2.38--> <!--Generated by: SAPIEN PowerShell HelpWriter 2017 v2.1.35--> <!-- Module: Kelverion.IntegrationModule.Oracle Version: 1.0.0.0 --> <!--All Commands--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Delete-OracleRow</command:name> <maml:description> <maml:para>Deletes rows from a database table using Runbook Studio filter criteria to determine which rows should be deleted.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Delete</command:verb> <command:noun>OracleRow</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Delete-OracleRow cmdlet deletes rows from an Oracle database table using Runbook Studio filter criteria to determine which rows should be deleted. If you do not provided any filters, the table will be truncated.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Delete-OracleRow</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specifies the name of the table that contains the rows to be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies the filters that will be used to determine what rows to delete. Typically used in conjunction with Runbook Studio to build graphical runbooks for Azure Automation. If you do not provided any filters, the table will be truncated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>Specifies the number of seconds to wait before terminating the attempt to execute the database command and generating an error.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the Oracle database server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specifies the name of the table that contains the rows to be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies the filters that will be used to determine what rows to delete. Typically used in conjunction with Runbook Studio to build graphical runbooks for Azure Automation. If you do not provided any filters, the table will be truncated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>Specifies the number of seconds to wait before terminating the attempt to execute the database command and generating an error.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the Oracle database server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The cmdlet returns an integer that Indicates the number of rows that were deleted or -1 if the table was truncated.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Specifying Connection Information</maml:title> <maml:alert> <maml:para>The Connection parameter is used to provide the cmdlet with connection information. You must include the following information:</maml:para> <maml:para>HostName: the IP address or name of the Oracle server . Port: the port number of the Oracle server. The default is 1521 ServiceName: the service name of the Oracle database UserName: the name of the user you want to connect as Password: the password of the user that you are connecting as. ConnectionTimeout: The number of seconds to wait to establish a connection with the database</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Insert-OracleRow</command:name> <maml:description> <maml:para>Inserts a row into a database table.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Insert</command:verb> <command:noun>OracleRow</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Insert-OracleRow cmdlet inserts a single row into an Oracle database table using values that you provide.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Insert-OracleRow</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specifies the name of the table to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing column values. You must provide values for any columns that do not allow NULL values.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>Specifies the number of seconds to wait before terminating the attempt to execute the database command and generating an error.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the Oracle database server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specifies the name of the table to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing column values. You must provide values for any columns that do not allow NULL values.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>Specifies the number of seconds to wait before terminating the attempt to execute the database command and generating an error.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the Oracle database server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The cmdlet does not generate any output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Specifying Connection Information</maml:title> <maml:alert> <maml:para>The Connection parameter is used to provide the cmdlet with connection information. You must include the following information:</maml:para> <maml:para>HostName: the IP address or name of the Oracle server . Port: the port number of the Oracle server. The default is 1521 ServiceName: the service name of the Oracle database UserName: the name of the user you want to connect as Password: the password of the user that you are connecting as. ConnectionTimeout: The number of seconds to wait to establish a connection with the database.</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Invoke-OracleCommand</command:name> <maml:description> <maml:para>Invoke an Oracle SQL statement.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>OracleCommand</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Invoke-OracleCommand cmdlet invokes a SQL command in an Oracle database.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="ExecuteQuery" default="true"> <!--NAME: ExecuteQuery--> <!--TAG: DEFAULT--> <maml:name>Invoke-OracleCommand</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Command</maml:name> <maml:description> <maml:para>Specifies the SQL query or command to be executed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>Specifies the number of seconds to wait before terminating the attempt to execute the database command and generating an error.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the Oracle database server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ExecuteScaler"> <!--NAME: ExecuteScaler--> <maml:name>Invoke-OracleCommand</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Command</maml:name> <maml:description> <maml:para>Specifies the SQL query or command to be executed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExecuteScaler</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should execute the SQL command and return the first column of the first row in the result set returned by the query (additional columns or rows are ignored).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>Specifies the number of seconds to wait before terminating the attempt to execute the database command and generating an error.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the Oracle database server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ExecuteNonQuery"> <!--NAME: ExecuteNonQuery--> <maml:name>Invoke-OracleCommand</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Command</maml:name> <maml:description> <maml:para>Specifies the SQL query or command to be executed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExecuteNonQuery</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should execute the SQL command and return the number of rows that were affected</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>Specifies the number of seconds to wait before terminating the attempt to execute the database command and generating an error.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the Oracle database server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Command</maml:name> <maml:description> <maml:para>Specifies the SQL query or command to be executed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>Specifies the number of seconds to wait before terminating the attempt to execute the database command and generating an error.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the Oracle database server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExecuteScaler</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should execute the SQL command and return the first column of the first row in the result set returned by the query (additional columns or rows are ignored).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExecuteNonQuery</maml:name> <maml:description> <maml:para>Indicates that the cmdlet should execute the SQL command and return the number of rows that were affected</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>When using the ExecuteQuery parameter set, the cmdlet returns objects that represent the data in the result set. The properties of the object coincide with the columns in the table.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>When using the ExecuteScaler parameter set, the cmdlet returns an object that represents the first column of the first row in the result set returned by the query (additional columns or rows are ignored).</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>When using the ExecuteNonQuery parameter set, the cmdlet returns a number that indicates the number of rows that were affected.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Specifying Connection Information</maml:title> <maml:alert> <maml:para>The Connection parameter is used to provide the cmdlet with connection information. You must include the following information:</maml:para> <maml:para>HostName: the IP address or name of the Oracle server . Port: the port number of the Oracle server. The default is 1521 ServiceName: the service name of the Oracle database UserName: the name of the user you want to connect as Password: the password of the user that you are connecting as. ConnectionTimeout: The number of seconds to wait to establish a connection with the database.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para>Execute the command as a query that returns rows from a join of the EMPLOYEES and DEPARTMENTS tables</maml:para> </maml:introduction> <dev:code>C:\PS> $employees = Invoke-OracleCommand -Connection $connection -Command "SELECT * FROM EMPLOYEES JOIN DEPARTMENT ON EMPLOYEES.DEPARTMENT_ID = DEPARTMENT.DEPARTMENT_ID"</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para>Uses the ExecuteScaler switch to invoke and SQL command the counts rows in the EMPLOYEES table and return the result as an Int32 value.</maml:para> </maml:introduction> <dev:code>C:\PS> $numEmployees = Invoke-OracleCommand -Connection $connection -ExecuteScaler -Command "SELECT COUNT(EMPLOYEE_ID) FROM EMPLOYEES WHERE SALARY > 10000"</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para>Uses the ExecuteNonQuery switch to update the EMPLOYEES table and return the number of rows affected.</maml:para> </maml:introduction> <dev:code>C:\PS>$numUpdated = Invoke-OracleCommand -Connection $connection -ExecuteNonQuery -Command "UPDATE EMPLOYEE SET JOB = 'MANAGER' WHERE JOB IS NULL"</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Invoke-OracleProcedure</command:name> <maml:description> <maml:para>Invokes a stored procedure.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>OracleProcedure</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Invoke-OracleProcedure cmdlet invokes a stored procedure in an Oracle database.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Invoke-OracleProcedure</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProcedureName</maml:name> <maml:description> <maml:para>Specifies the name of the stored procedure to be invoked.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing input parameter values.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>Specifies the number of seconds to wait before terminating the attempt to execute the database command and generating an error.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the Oracle database server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProcedureName</maml:name> <maml:description> <maml:para>Specifies the name of the stored procedure to be invoked.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing input parameter values.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>Specifies the number of seconds to wait before terminating the attempt to execute the database command and generating an error.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the Oracle database server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Specifying Connection Information</maml:title> <maml:alert> <maml:para>The Connection parameter is used to provide the cmdlet with connection information. You must include the following information:</maml:para> <maml:para>HostName: the IP address or name of the Oracle server . Port: the port number of the Oracle server. The default is 1521 ServiceName: the service name of the Oracle database UserName: the name of the user you want to connect as Password: the password of the user that you are connecting as. ConnectionTimeout: The number of seconds to wait to establish a connection with the database.</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Select-OracleRow</command:name> <maml:description> <maml:para>Selects rows from a database table using Runbook Studio filter criteria to determine which rows to retrieve.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Select</command:verb> <command:noun>OracleRow</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Select-OracleRow cmdlet selects rows from an Oracle database table using Runbook Studio filter criteria.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Select-OracleRow</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specifies the name of the table or view that contains the rows to be selected.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies the filters that will be used to determine what rows to select. Typically used in conjunction with Runbook Studio to build graphical runbooks for Azure Automation. If you do not provide any filters, all rows in the table will be updated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Descending</maml:name> <maml:description> <maml:para>Indicates that the rows should be retrieved in descending order. The default is ascending order.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the column that should be used to order the rows.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of rows to select.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>Specifies the number of seconds to wait before terminating the attempt to execute the database command and generating an error.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the Oracle database server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>WithTies</maml:name> <maml:description> <maml:para>Specifies that ties should be considered when applying row limits.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>Percentage</maml:name> <maml:description> <maml:para>Specifies that the value of the Top parameter should be evaluated as a percentage.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the number of rows to skip before row limiting starts. The default is no offset.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specifies the name of the table or view that contains the rows to be selected.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies the filters that will be used to determine what rows to select. Typically used in conjunction with Runbook Studio to build graphical runbooks for Azure Automation. If you do not provide any filters, all rows in the table will be updated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Descending</maml:name> <maml:description> <maml:para>Indicates that the rows should be retrieved in descending order. The default is ascending order.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the column that should be used to order the rows.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of rows to select.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>Specifies the number of seconds to wait before terminating the attempt to execute the database command and generating an error.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the Oracle database server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the number of rows to skip before row limiting starts. The default is no offset.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>Percentage</maml:name> <maml:description> <maml:para>Specifies that the value of the Top parameter should be evaluated as a percentage.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>WithTies</maml:name> <maml:description> <maml:para>Specifies that ties should be considered when applying row limits.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The cmdlet returns objects representing the rows that were selected. The properties of the custom object coincide with the columns in the table.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Specifying Connection Information</maml:title> <maml:alert> <maml:para>The Connection parameter is used to provide the cmdlet with connection information. You must include the following information:</maml:para> <maml:para>HostName: the IP address or name of the Oracle server . Port: the port number of the Oracle server. The default is 1521 ServiceName: the service name of the Oracle database UserName: the name of the user you want to connect as Password: the password of the user that you are connecting as. ConnectionTimeout: The number of seconds to wait to establish a connection with the database.</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Update-OracleRow</command:name> <maml:description> <maml:para>Updates rows in a database table using Runbook Studio filter criteria to determine which rows to update.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Update</command:verb> <command:noun>OracleRow</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Update-OracleRow cmdlet updates rows in an Oracle database table using Runbook Studio filter criteria to determine which rows to update. If you do not provide any filters, all rows in the table will be updated.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Update-OracleRow</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specifies the name of the table or view that contains the rows to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing values for the columns to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies the filters that will be used to determine what rows to update. Typically used in conjunction with Runbook Studio to build graphical runbooks for Azure Automation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>Specifies the number of seconds to wait before terminating the attempt to execute the database command and generating an error.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the Oracle database server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Specifies the name of the table or view that contains the rows to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing values for the columns to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies the filters that will be used to determine what rows to update. Typically used in conjunction with Runbook Studio to build graphical runbooks for Azure Automation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>CommandTimeout</maml:name> <maml:description> <maml:para>Specifies the number of seconds to wait before terminating the attempt to execute the database command and generating an error.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to the Oracle database server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The cmdlet returns an integer that indicates the number of rows that were updated.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Specifying Connection Information</maml:title> <maml:alert> <maml:para>The Connection parameter is used to provide the cmdlet with connection information. You must include the following information:</maml:para> <maml:para>HostName: the IP address or name of the Oracle server . Port: the port number of the Oracle server. The default is 1521 ServiceName: the service name of the Oracle database UserName: the name of the user you want to connect as Password: the password of the user that you are connecting as. ConnectionTimeout: The number of seconds to wait to establish a connection with the database.</maml:para> </maml:alert> </maml:alertSet> </command:command> <!--Generated by: SAPIEN PowerShell HelpWriter 2017 v2.1.35--> </helpItems> |