PSql.Core.xml
|
<?xml version="1.0" encoding="utf-8"?> <doc> <assembly> <name>PSql.Core</name> </assembly> <members> <member name="T:PSql.IConsole"> <summary> Abstract view of a PowerShell-like console. </summary> </member> <member name="M:PSql.IConsole.WriteObject(System.Object)"> <summary> Writes the specified object to the output stream as a single object, even if the object is enumerable. </summary> <param name="obj"> The object to write. </param> </member> <member name="M:PSql.IConsole.WriteObject(System.Object,System.Boolean)"> <summary> Writes the specified object to the output stream, optionally enumerating the object if it is enumerable. </summary> <param name="obj"> The object to write. </param> <param name="enumerate"> <see langword="true" /> to enumerate <paramref name="obj" /> if it is enumerable; <see langword="false" /> otherwise. </param> </member> <member name="M:PSql.IConsole.WriteError(System.Management.Automation.ErrorRecord)"> <summary> Writes the specified record to the error stream. </summary> <param name="record"> The record to write. </param> </member> <member name="M:PSql.IConsole.WriteWarning(System.String)"> <summary> Writes the specified text to the warning stream. </summary> <param name="text"> The text to write. </param> </member> <member name="M:PSql.IConsole.WriteVerbose(System.String)"> <summary> Writes the specified text to the verbose stream. </summary> <param name="text"> The text to write. </param> </member> <member name="M:PSql.IConsole.WriteDebug(System.String)"> <summary> Writes the specified text to the debug stream. </summary> <param name="text"> The text to write. </param> </member> <member name="M:PSql.IConsole.WriteHost(System.String,System.Boolean,System.Nullable{System.ConsoleColor},System.Nullable{System.ConsoleColor})"> <summary> Writes the specified text to the host. </summary> <param name="text"> The text to write. </param> <param name="newLine"> Whether a newline should follow the message. </param> <param name="foregroundColor"> The foreground color to use. </param> <param name="backgroundColor"> The background color to use. </param> <remarks> This method is similar to the PowerShell <c>Write-Host</c> cmdlet. </remarks> </member> <member name="M:PSql.IConsole.WriteInformation(System.Management.Automation.InformationRecord)"> <summary> Writes the specified record to the information stream or host. </summary> <param name="record"> The record to write. </param> </member> <member name="M:PSql.IConsole.WriteInformation(System.Object,System.String[])"> <summary> Writes the specified data to the information stream or host. </summary> <param name="data"> The object or message data to write. </param> <param name="tags"> Tags to be associated with the message data. </param> </member> <member name="M:PSql.IConsole.WriteProgress(System.Management.Automation.ProgressRecord)"> <summary> Writes the specified record to the progress stream. </summary> <param name="record"> The record to write. </param> </member> <member name="M:PSql.IConsole.WriteCommandDetail(System.String)"> <summary> Writes the specified text to the pipeline execution log. </summary> <param name="text"> The text to write. </param> </member> <member name="M:PSql.IConsole.ShouldContinue(System.String,System.String)"> <summary> Confirms an action or group of actions via a prompt with the options <b>yes</b> and <b>no</b>. </summary> <param name="query"> A question asking whether the action should be performed. </param> <param name="caption"> A window caption that the user interface might display. </param> <returns> <see langword="true" /> if the action should be performed; <see langword="false" /> otherwise. </returns> <remarks> Unlike <c>ShouldProcess</c>, preference settings or command-line parameters do not affect this method. </remarks> </member> <member name="M:PSql.IConsole.ShouldContinue(System.String,System.String,System.Boolean@,System.Boolean@)"> <summary> Confirms an action or group of actions via a prompt with the options <b>yes</b>, <b>yes to all</b>, <b>no</b>, and <b>no to all</b>. </summary> <param name="query"> A question asking whether the action should be performed. </param> <param name="caption"> A window caption that the user interface might display. </param> <param name="yesToAll"> <see langword="true" /> to bypass the prompt and return <see langword="true" />; otherwise, on return, this parameter is set to <see langword="true" /> if the user responds <b>yes to all</b>. </param> <param name="noToAll"> <see langword="true" /> to bypass the prompt and return <see langword="false" />; otherwise, on return, this parameter is set to <see langword="true" /> if the user responds <b>no to all</b>. </param> <returns> <see langword="true" /> if the action should be performed; <see langword="false" /> otherwise. </returns> </member> <member name="M:PSql.IConsole.ShouldContinue(System.String,System.String,System.Boolean,System.Boolean@,System.Boolean@)"> <summary> Confirms an action or group of actions via a prompt with the options <b>yes</b>, <b>yes to all</b>, <b>no</b>, and <b>no to all</b>. </summary> <param name="query"> A question asking whether the action should be performed. </param> <param name="caption"> A window caption that the user interface might display. </param> <param name="hasSecurityImpact"> <see langword="true" /> if the action has a security impact; <see langword="false" /> otherwise. The default response is <b>no</b> for actions with a security impact. </param> <param name="yesToAll"> <see langword="true" /> to bypass the prompt and return <see langword="true" />; otherwise, on return, this parameter is set to <see langword="true" /> if the user responds <b>yes to all</b>. </param> <param name="noToAll"> <see langword="true" /> to bypass the prompt and return <see langword="false" />; otherwise, on return, this parameter is set to <see langword="true" /> if the user responds <b>no to all</b>. </param> <returns> <see langword="true" /> if the action should be performed; <see langword="false" /> otherwise. </returns> </member> <member name="M:PSql.IConsole.ShouldProcess(System.String)"> <summary> Confirms whether an action should be performed. </summary> <param name="target"> The name of the target on which an action is to be performed. </param> <returns> <see langword="true" /> if the action should be performed; <see langword="false" /> otherwise. </returns> <remarks> Commands that make changes should invoke a <c>ShouldProcess</c> method to give the user an opportunity to confirm that a change actually should be performed. </remarks> </member> <member name="M:PSql.IConsole.ShouldProcess(System.String,System.String)"> <summary> Confirms whether an action should be performed. </summary> <param name="target"> The name of the target on which the action is to be performed. </param> <param name="action"> The name of the action to be performed. </param> <returns> <see langword="true" /> if the action should be performed; <see langword="false" /> otherwise. </returns> <remarks> Commands that make changes should invoke a <c>ShouldProcess</c> method to give the user an opportunity to confirm that a change actually should be performed. </remarks> </member> <member name="M:PSql.IConsole.ShouldProcess(System.String,System.String,System.String)"> <summary> Confirms whether an action should be performed. </summary> <param name="description"> A description of the action to be performed. This text is used for <see cref="F:System.Management.Automation.ActionPreference.Continue" />. </param> <param name="query"> A question asking whether the action should be performed. This text is used for <see cref="F:System.Management.Automation.ActionPreference.Inquire" />. </param> <param name="caption"> A window caption that the user interface might display. </param> <returns> <see langword="true" /> if the action should be performed; <see langword="false" /> otherwise. </returns> <remarks> Commands that make changes should invoke a <c>ShouldProcess</c> method to give the user an opportunity to confirm that a change actually should be performed. </remarks> </member> <member name="M:PSql.IConsole.ShouldProcess(System.String,System.String,System.String,System.Management.Automation.ShouldProcessReason@)"> <summary> Confirms whether an action should be performed. </summary> <param name="description"> A description of the action to be performed. This text is used for <see cref="F:System.Management.Automation.ActionPreference.Continue" />. </param> <param name="query"> A question asking whether the action should be performed. This text is used for <see cref="F:System.Management.Automation.ActionPreference.Inquire" />. </param> <param name="caption"> A window caption that the user interface might display. </param> <param name="reason"> On return, indicates the reason(s) for the return value. </param> <returns> <see langword="true" /> if the action should be performed; <see langword="false" /> otherwise. </returns> <remarks> Commands that make changes should invoke a <c>ShouldProcess</c> method to give the user an opportunity to confirm that a change actually should be performed. </remarks> </member> <member name="M:PSql.IConsole.ThrowTerminatingError(System.Management.Automation.ErrorRecord)"> <summary> Terminates the current command and reports an error. </summary> <param name="record"> The error to report. </param> </member> <member name="T:PSql.ISqlCommand"> <summary> Represents a SQL command (statement batch) to execute against SQL Server, Azure SQL Database, or compatible product. </summary> <remarks> This type is a proxy for <c>Microsoft.Data.SqlClient.SqlCommand</c>. </remarks> </member> <member name="P:PSql.ISqlCommand.UnderlyingCommand"> <summary> Gets the underlying <c>Microsoft.Data.SqlClient.SqlCommand</c>. </summary> </member> <member name="P:PSql.ISqlCommand.CommandTimeout"> <summary> Gets or sets the duration in seconds after which command execution times out. A value of <c>0</c> indicates no timeout: the command is allowed to execute indefinitely. </summary> <exception cref="T:System.ArgumentException"> Attempted to set a value less than <c>0</c>. </exception> </member> <member name="P:PSql.ISqlCommand.CommandText"> <summary> Gets or sets the SQL command (statement batch) to execute. </summary> </member> <member name="M:PSql.ISqlCommand.ExecuteAndProjectToPSObjects(System.Boolean)"> <summary> Executes the command and projects its result rows to PowerShell objects. </summary> <param name="useSqlTypes"> <see langword="false" /> to project fields using CLR types from the <see cref="N:System" /> namespace, such as <see cref="T:System.Int32" />. <see langword="true" /> to project fields using SQL types from the <see cref="N:System.Data.SqlTypes" /> namespace, such as <see cref="T:System.Data.SqlTypes.SqlInt32" />. </param> <returns> A sequence of objects created by executing the command and projecting each result row to a PowerShell object. If the command produces no result rows, this method returns an empty sequence. </returns> <exception cref="T:System.InvalidCastException"> Thrown by the underlying ADO.NET connection or command objects. </exception> <exception cref="T:System.InvalidOperationException"> Thrown by the underlying ADO.NET connection or command objects. </exception> <exception cref="T:System.IO.IOException"> Thrown by the underlying ADO.NET connection or command objects. </exception> <exception cref="T:System.Data.Common.DbException"> Thrown by the underlying ADO.NET connection or command objects. </exception> <exception cref="T:System.ObjectDisposedException"> Thrown by the underlying ADO.NET connection or command objects. </exception> </member> <member name="T:PSql.ISqlConnection"> <summary> Represents a connection to SQL Server, Azure SQL Database, or compatible product. </summary> <remarks> This type is a proxy for <c>Microsoft.Data.SqlClient.SqlConnection</c>. </remarks> </member> <member name="P:PSql.ISqlConnection.UnderlyingConnection"> <summary> Gets the underlying <c>Microsoft.Data.SqlClient.SqlConnection</c>. </summary> </member> <member name="P:PSql.ISqlConnection.ConnectionString"> <summary> Gets the connection string used to create the connection. </summary> </member> <member name="P:PSql.ISqlConnection.IsOpen"> <summary> Gets a value indicating whether the connection is open. The value is <see langword="true" /> for new connections and transitions to <see langword="false" /> permanently when the connection closes. </summary> </member> <member name="P:PSql.ISqlConnection.HasErrors"> <summary> Gets a value indicating whether errors have been logged on the connection since the most recent call to <see cref="M:PSql.ISqlConnection.ClearErrors" />. </summary> </member> <member name="M:PSql.ISqlConnection.ClearErrors"> <summary> Sets <see cref="P:PSql.ISqlConnection.HasErrors" /> to <see langword="false" />, forgetting about any errors prevously logged on the connection. </summary> </member> <member name="M:PSql.ISqlConnection.ThrowIfHasErrors"> <summary> Throws <see cref="T:System.Data.DataException" /> if errors have been logged on the connection since the most recent call to <see cref="M:PSql.ISqlConnection.ClearErrors" />. </summary> <exception cref="T:System.Data.DataException"> At least one error was logged on the connection since the most recent call to <see cref="M:PSql.ISqlConnection.ClearErrors" />. </exception> </member> <member name="M:PSql.ISqlConnection.CreateCommand"> <summary> Creates a new <see cref="T:PSql.ISqlCommand" /> instance that can execute commands on the connection. </summary> </member> <member name="T:PSql.StringExtensions"> <summary> Extension methods for <see cref="T:System.String" />. </summary> </member> <member name="M:PSql.StringExtensions.HasContent(System.String)"> <summary> Checks whether the string is neither <see langword="null" /> nor empty (<c>""</c>). </summary> <param name="s"> The string to check. </param> <returns> <see langword="true" /> if <paramref name="s" /> is neither <see langword="null" /> nor empty (<c>""</c>); <see langword="false" /> otherwise. </returns> </member> <member name="M:PSql.StringExtensions.IsNullOrEmpty(System.String)"> <summary> Checks whether the string is either <see langword="null" /> or empty (<c>""</c>). </summary> <param name="s"> The string to check. </param> <returns> <see langword="true" /> if <paramref name="s" /> is either <see langword="null" /> or empty (<c>""</c>); <see langword="false" /> otherwise. </returns> </member> <member name="M:PSql.StringExtensions.NullIfEmpty(System.String)"> <summary> Replaces an empty string (<c>""</c>) with <see langword="null" />. </summary> <param name="s"> The string to transform. </param> <returns> <see langword="null" /> if <paramref name="s" /> is empty (<c>""</c>); <paramref name="s" /> otherwise. </returns> </member> </members> </doc> |