deps/PSql.Engine.xml
|
<?xml version="1.0" encoding="utf-8"?> <doc> <assembly> <name>PSql.Engine</name> </assembly> <members> <member name="T:PSql.IObjectBuilder`1"> <summary> A strategy to build objects dynamically. </summary> <typeparam name="T"> The type of objects that the builder can build. </typeparam> </member> <member name="M:PSql.IObjectBuilder`1.NewObject"> <summary> Creates a new object. </summary> <returns> A new instance of type <typeparamref name="T" />. </returns> </member> <member name="M:PSql.IObjectBuilder`1.AddProperty(`0,System.String,System.Object)"> <summary> Adds a property to the specified object. </summary> <param name="obj"> The object to which to add the property. </param> <param name="name"> The name of the property to add. </param> <param name="value"> The value of the property to add. </param> <exception cref="T:System.ArgumentNullException"> <paramref name="obj" /> or <paramref name="name" /> is <see langword="null" />. </exception> </member> <member name="T:PSql.ISqlMessageLogger"> <summary> An object that logs server messages received over a database connection. </summary> </member> <member name="M:PSql.ISqlMessageLogger.Log(System.String,System.Int32,System.Int32,System.Int32,System.String)"> <summary> Logs the specified message. </summary> <param name="procedure"> The name of the stored procedure or remote procedure call that generated the message. Analogous to the T-SQL <c>ERROR_PROCEDURE</c> function. </param> <param name="line"> The line number within the stored procedure or command batch that generated the message. Analogous to the T-SQL <c>ERROR_LINE</c> function. </param> <param name="number"> The number that identifies the kind of message. Analogous to the T-SQL <c>ERROR_NUMBER</c> function. </param> <param name="severity"> The severity level of the message. Analogous to the T-SQL <c>ERROR_SEVERITY</c> function. </param> <param name="message"> The text of the message. Analogous to the T-SQL <c>ERROR_MESSAGE</c> function. </param> </member> <member name="T:PSql.NullSqlMessageLogger"> <summary> An <see cref="T:PSql.ISqlMessageLogger" /> that does nothing. </summary> </member> <member name="P:PSql.NullSqlMessageLogger.Instance"> <summary> Gets the singleton <see cref="T:PSql.NullSqlMessageLogger" /> instance. </summary> </member> <member name="M:PSql.NullSqlMessageLogger.Log(System.String,System.Int32,System.Int32,System.Int32,System.String)"> <summary> Logs the specified message. </summary> <param name="procedure"> The name of the stored procedure or remote procedure call that generated the message. Analogous to the T-SQL <c>ERROR_PROCEDURE</c> function. </param> <param name="line"> The line number within the stored procedure or command batch that generated the message. Analogous to the T-SQL <c>ERROR_LINE</c> function. </param> <param name="number"> The number that identifies the kind of message. Analogous to the T-SQL <c>ERROR_NUMBER</c> function. </param> <param name="severity"> The severity level of the message. Analogous to the T-SQL <c>ERROR_SEVERITY</c> function. </param> <param name="message"> The text of the message. Analogous to the T-SQL <c>ERROR_MESSAGE</c> function. </param> </member> <member name="T:PSql.SqlCmdPreprocessor"> <summary> A minimal <c>sqlcmd</c>-style preprocessor. </summary><remarks><para> This type supports a limited subset of <c>sqlcmd</c> preprocessing features: </para><list type="table"><item><term><c>GO</c></term><description>batch separator</description></item><item><term><c>$()</c></term><description><c>sqlcmd</c> variable expansion</description></item><item><term><c>:setvar</c></term><description>set a <c>sqlcmd</c> variable</description></item><item><term><c>:r</c></term><description>include a file</description></item></list><para> For more information, see <a href="https://docs.microsoft.com/en-us/sql/tools/sqlcmd-utility">the documentation</a> for the <c>sqlcmd</c> utility. </para></remarks> </member> <member name="M:PSql.SqlCmdPreprocessor.#ctor"> <summary> Initializes a new <see cref="T:PSql.SqlCmdPreprocessor" /> instance. </summary> </member> <member name="P:PSql.SqlCmdPreprocessor.EnableVariableReplacementInComments"> <summary> Gets or sets whether the preprocessor performs variable replacement in comments. The default value is <see langword="false" /> to match SQLCMD behavior. </summary> </member> <member name="M:PSql.SqlCmdPreprocessor.SetVariables(System.Collections.IDictionary)"> <summary> Defines the specified <c>sqlcmd</c> variables. </summary> <param name="entries"> The variables to define. </param> </member> <member name="M:PSql.SqlCmdPreprocessor.Process(System.String)"> <summary> Preprocesses the specified text. </summary><param name="text"> The text to be preprocessed. </param><returns> The result of preprocessing <paramref name="text" />, split into <c>GO</c>-separated batches. </returns><exception cref="T:System.ArgumentNullException"><paramref name="text" /> is <see langword="null" />. </exception><exception cref="T:Prequel.SqlCmdException"> The preprocessor encountered an error in the usage of a <c>sqlcmd</c> feature. </exception> </member> <member name="T:PSql.SqlConnection"> <summary> A connection to a SQL Server database or Azure SQL Database instance. </summary> </member> <member name="M:PSql.SqlConnection.#ctor(System.String,System.Net.NetworkCredential,PSql.ISqlMessageLogger)"> <summary> Initializes a new <see cref="T:PSql.SqlConnection" /> instance. </summary> <param name="connectionString"> A string that specifies parameters for the connection. </param> <param name="credential"> The credential to use to authenticate with the server, or <see langword="null" /> if the <paramref name="connectionString" /> contains all information necessary to authenticate. </param> <param name="logger"> The logger for server messages received over the connection. </param> <exception cref="T:System.ArgumentNullException"> <paramref name="connectionString" /> or <paramref name="logger" /> is <see langword="null" />. </exception> <exception cref="T:System.ArgumentException"> <paramref name="connectionString" /> is invalid. </exception> <exception cref="T:System.Data.Common.DbException"> A connection-level error occurred while opening the connection. </exception> </member> <member name="P:PSql.SqlConnection.RetryLogicProvider"> <summary> Gets the retry logic for connections. </summary> </member> <member name="P:PSql.SqlConnection.ConnectionString"> <summary> Gets the string that specifies parameters for the connection. </summary> </member> <member name="P:PSql.SqlConnection.Connection"> <summary> Gets the underlying SqlClient connection. </summary> </member> <member name="P:PSql.SqlConnection.Command"> <summary> Gets the underlying SqlClient command. </summary> </member> <member name="P:PSql.SqlConnection.Logger"> <summary> Gets the logger for server messages received over the connection. </summary> </member> <member name="P:PSql.SqlConnection.HasErrors"> <summary> Gets whether one or more error messages have been received over the connection since the most recent invocation of <see cref="M:PSql.SqlConnection.ClearErrors" />. </summary> </member> <member name="P:PSql.SqlConnection.IsOpen"> <summary> Gets whether the connection is open. </summary> </member> <member name="M:PSql.SqlConnection.ThrowIfHasErrors"> <summary> Throws an exception if one or more error messages have been received over the connection since the most recent invocation of <see cref="M:PSql.SqlConnection.ClearErrors" />. </summary> <exception cref="T:System.Data.DataException"> One or more error messages have been received over the connection since the most recent invocation of <see cref="M:PSql.SqlConnection.ClearErrors" />. </exception> </member> <member name="M:PSql.SqlConnection.ClearErrors"> <summary> Resets error-handling state, forgetting any error messages that have been received over the connection. </summary> </member> <member name="M:PSql.SqlConnection.SetUpCommand(System.String,System.Int32)"> <summary> Configures the <see cref="P:PSql.SqlConnection.Command" /> object. </summary> <param name="sql"> The command text to execute. </param> <param name="timeout"> The command timeout, in seconds, or <c>0</c> for no timeout. </param> <returns> The value of the <see cref="P:PSql.SqlConnection.Command" /> property, configured with the specified <paramref name="sql" /> and <paramref name="timeout" />. </returns> <exception cref="T:System.ArgumentNullException"> <paramref name="sql" /> is <see langword="null" />. </exception> <exception cref="T:System.ArgumentOutOfRangeException"> <paramref name="timeout" /> is less than <c>0</c>. </exception> </member> <member name="M:PSql.SqlConnection.AutoOpenAsync(System.Threading.CancellationToken)"> <summary> Ensures that the connection is open. </summary> </member> <member name="M:PSql.SqlConnection.ExecuteAndProjectAsync``1(System.String,PSql.IObjectBuilder{``0},System.Int32,System.Boolean,System.Threading.CancellationToken)"> <summary> Executes the specified SQL batch asynchronously and projects its result rows to objects using the specified builder. </summary> <typeparam name="T"> The type of object produced by <paramref name="builder" />. </typeparam> <param name="sql"> The SQL batch to execute. </param> <param name="builder"> The strategy to project result rows to objects. </param> <param name="timeout"> The command timeout, in seconds, or <c>0</c> for no timeout. </param> <param name="useSqlTypes"> <see langword="false" /> to project column values using CLR types from the <see cref="N:System" /> namespace, such as <see cref="T:System.Int32" />. <see langword="true" /> to project column values using SQL types from the <see cref="N:System.Data.SqlTypes" /> namespace, such as <see cref="T:System.Data.SqlTypes.SqlInt32" />. </param> <param name="cancellation"> A token to monitor for cancellation requests. </param> <returns> A task that represents the asynchronous operation, yielding a sequence of objects created by executing the <paramref name="sql" /> batch and projecting each result row to an object using the <paramref name="builder" />. If the command produces no result rows, the task yields an empty sequence. </returns> <exception cref="T:System.ArgumentNullException"> <paramref name="sql" /> or <paramref name="builder" /> is <see langword="null" />. </exception> <exception cref="T:System.ArgumentOutOfRangeException"> <paramref name="timeout" /> is less than <c>0</c>. </exception> <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="M:PSql.SqlConnection.Dispose"> <summary> Closes the connection and frees resources owned by it. </summary> </member> <member name="T:PSql.SqlErrorHandling"> <summary> Convenience methods for SQL error handling. </summary> </member> <member name="M:PSql.SqlErrorHandling.Apply(System.Collections.Generic.IEnumerable{System.String})"> <summary> Combines the specified SQL batches into a single superbatch with an error-handling wrapper that improves the diagnostic experience. </summary> <param name="batches"> The SQL batches to combine. </param> <returns> A superbatch that consists of the given <paramref name="batches" /> with an error-handling wrapper. </returns> <exception cref="T:System.ArgumentNullException"> <paramref name="batches" /> is <see langword="null" />. </exception> </member> <member name="T:PSql.SqlErrorHandlingBuilder"> <summary> A builder that combines SQL batches into a single superbatch with an error-handling wrapper that improves the diagnostic experience. </summary> </member> <member name="M:PSql.SqlErrorHandlingBuilder.#ctor"> <summary> Initializes a new <see cref="T:PSql.SqlErrorHandlingBuilder" /> instance. </summary> </member> <member name="P:PSql.SqlErrorHandlingBuilder.IsEmpty"> <summary> Gets whether the builder is empty. </summary> </member> <member name="M:PSql.SqlErrorHandlingBuilder.StartNewBatch"> <summary> Ends the current batch and begins a new batch. </summary> <remarks> If the current batch is empty, this method has no effect. </remarks> </member> <member name="M:PSql.SqlErrorHandlingBuilder.Append(System.String)"> <summary> Appends the specified SQL code to the current batch. </summary> <param name="sql"> The SQL code to append to the current batch. </param> <exception cref="T:System.ArgumentNullException"> <paramref name="sql" /> is <see langword="null" />. </exception> <remarks> If <paramref name="sql" /> is empty, this method has no effect. </remarks> </member> <member name="M:PSql.SqlErrorHandlingBuilder.Append(System.String,System.Text.RegularExpressions.Capture)"> <summary> Appends the specified span of SQL code to the current batch. </summary> <param name="sql"> A string that contains SQL code to append to the current batch. </param> <param name="capture"> A regular expression capture whose <see cref="P:System.Text.RegularExpressions.Capture.Index" /> and <see cref="P:System.Text.RegularExpressions.Capture.Length" /> properties specify the span of SQL code within <paramref name="sql" /> to add to the current batch. </param> <exception cref="T:System.ArgumentNullException"> <paramref name="sql" /> and/or <paramref name="capture" /> is <see langword="null" />. </exception> <remarks> If <paramref name="capture" /> zero-length, this method has no effect. </remarks> </member> <member name="M:PSql.SqlErrorHandlingBuilder.Append(System.String,System.Int32,System.Int32)"> <summary> Appends the specified span of SQL code to the current batch. </summary> <param name="sql"> A string that contains SQL code to append to the current batch. </param> <param name="index"> The index of the span of SQL code within <paramref name="sql" /> to add to the current batch. </param> <param name="length"> The length of the span of SQL code within <paramref name="sql" /> to add to the current batch. </param> <exception cref="T:System.ArgumentNullException"> <paramref name="sql" /> is <see langword="null" />. </exception> <exception cref="T:System.ArgumentOutOfRangeException"> <paramref name="index" /> is negative or greater than the length of <paramref name="sql" />; or, <paramref name="length" /> is negative or greater than the length of the maximum span within <paramref name="sql" /> starting at <paramref name="index" />. </exception> <remarks> If <paramref name="length" /> is zero, this method has no effect. </remarks> </member> <member name="M:PSql.SqlErrorHandlingBuilder.Complete"> <summary> Ends the current batch, returns the accumulated superbatch with error-handling wrapper, and resets the builder to its initial state. </summary> <returns> The accumulated superbatch with error-handling wrapper. </returns> <remarks> If the builder has accumulated no batches, then this method returns an empty string. </remarks> </member> <member name="T:PSql.SqlMessageConstants"> <summary> Constants related to server messages received over database connections. </summary> </member> <member name="F:PSql.SqlMessageConstants.MaxInformationalSeverity"> <summary> The maximum severity level of an informational or advisory message. Messages of higher severity are errors. </summary> </member> </members> </doc> |