Dataverse reference

Interfaces

Type	Summary
IBulkOperationExecutor	Executes bulk operations using modern Dataverse APIs.
ICachedMetadataProvider	Provides cached access to Dataverse metadata for IntelliSense and entity browsing.
IConnectionSelectionStrategy	Strategy for selecting which connection to use from the pool.
IConnectionSource	Provides a seed ServiceClient for the connection pool to clone.
IDataverseClient	Abstraction over ServiceClient providing core Dataverse operations.
IDataverseConnectionPool	Manages a pool of Dataverse connections with intelligent selection and lifecycle management.
IMetadataAuthoringProgressReporter	Lightweight progress reporter for metadata authoring operations.
IMetadataQueryExecutor	Executes metadata queries against Dataverse, returning results as QueryRow format.
IMetadataQueryService	Provides access to Dataverse metadata for entity browsing and discovery.
IPooledClient	A client obtained from the connection pool.
IQueryExecutor	Executes FetchXML queries against Dataverse and returns structured results.
IQueryPlanNode	A node in the query execution plan tree (Volcano/iterator model).
IQueryProgressReporter	Lightweight progress reporter for query plan execution.
IScalarFunction	A scalar function that accepts arguments and returns a single value.
ISourceTokenizer	Produces source tokens for syntax highlighting.
ITdsQueryExecutor	Executes SQL queries against Dataverse's TDS Endpoint (read-only replica)
IThrottleTracker	Tracks throttle state across connections.

Classes

Type	Summary
AdaptiveAggregateScanNode	Wraps a FetchXML aggregate scan with adaptive retry. When the Dataverse
AdaptiveBatchSizer	Dynamically adjusts DML batch size based on observed execution times.
AdaptiveThrottleManager	Dynamically adjusts the degree of parallelism (DOP) for bulk DML operations
AddOptionValueRequest	Request to add a new option value to an existing option set.
AsyncOperation	Process whose execution can proceed independently or in the background.
AttributeMetadataDto	Detailed attribute metadata for entity browsing.
AuthenticationErrorDetector	Detects authentication and authorization failures from Dataverse operations.
BatchCoordinatorExhaustedException	Thrown when batch coordinator cannot acquire a slot within timeout.
BatchFailureDiagnostic	Diagnostic information for identifying the cause of a batch failure.
BatchParallelismCoordinator	Coordinates batch parallelism across all concurrent bulk operations.
BulkOperationError	Error details for a failed record in a bulk operation.
BulkOperationErrorCode	Structured error codes for bulk operation validation failures.
BulkOperationExecutor	Executes bulk operations using modern Dataverse APIs.
BulkOperationOptions	Configuration options for bulk operations.
BulkOperationValidationException	Exception thrown when bulk operation configuration fails validation.
CachedMetadataProvider	Provides cached access to Dataverse metadata, wrapping PPDS.Dataverse.Metadata.IMetadataQueryService
CascadeConfigurationDto	Defines the cascade behavior configuration for a relationship.
CastConverter	Implements T-SQL CAST/CONVERT type conversion semantics.
ClientAggregateColumn	Describes an aggregate column for client-side computation.
ClientAggregateNode	Computes aggregate functions client-side from raw (non-aggregated) input rows.
ClientFilterNode	Filters rows by evaluating a condition client-side.
ClientWindowNode	Computes window functions (ROW_NUMBER, RANK, DENSE_RANK, aggregate OVER) client-side.
CompiledPredicate	Compiled predicate: evaluates against a row and returns true/false.
CompiledScalarExpression	Compiled scalar expression: evaluates against a row and returns a value.
ConcatenateNode	Concatenates rows from multiple child nodes sequentially.
ConfigurationException	Exception thrown when Dataverse configuration is invalid.
ConnectionPoolOptions	Configuration options for the Dataverse connection pool.
ConnectionStatistics	Statistics for a specific connection configuration.
ConnectionStringBuilder	Builds Dataverse connection strings from typed configuration.
ConnectionStringRedactor	Provides utilities for redacting sensitive information from connection strings
ConnectionStringSource	Connection source that creates a ServiceClient from connection string configuration.
CorrelationIdScope	Ambient correlation-ID scope shared by the CLI, the RPC daemon, and every
CreateChoiceResult	Result of a create global choice operation.
CreateColumnRequest	Request to create a new column (attribute) on a Dataverse table.
CreateColumnResult	Result of a create column operation.
CreateGlobalChoiceRequest	Request to create a new global choice (option set) in Dataverse.
CreateKeyRequest	Request to create an alternate key on a Dataverse table.
CreateKeyResult	Result of a create alternate key operation.
CreateManyToManyRequest	Request to create a many-to-many (N:N) relationship between two Dataverse tables.
CreateOneToManyRequest	Request to create a one-to-many (1:N) relationship between two Dataverse tables.
CreateRelationshipResult	Result of a create relationship operation.
CreateTableRequest	Request to create a new Dataverse table (entity).
CreateTableResult	Result of a create table operation.
CustomAPI	Entity that defines a custom API
CustomAPIRequestParameter	Entity that defines a request parameter for a custom API
CustomAPIResponseProperty	Entity that defines a response property for a custom API
DataverseAuthenticationException	Exception thrown when a Dataverse operation fails due to authentication or authorization issues.
DataverseClient	Implementation of PPDS.Dataverse.Client.IDataverseClient that wraps a Microsoft.PowerPlatform.Dataverse.Client.ServiceClient.
DataverseClientOptions	Options for configuring a Dataverse client request.
DataverseConnection	Configuration for a Dataverse connection (Application User / Service Principal).
DataverseConnectionException	Exception thrown when a Dataverse connection fails.
DataverseConnectionPool	High-performance connection pool for Dataverse with multi-connection support.
DataverseEnvironmentOptions	Configuration for a named Dataverse environment.
DataverseFunctions	Dataverse-specific functions evaluated client-side.
DataverseMetadataQueryService	Provides access to Dataverse metadata using the SDK.
DataverseOptions	Root configuration options for Dataverse connection pooling and operations.
DateFunctions	T-SQL date/time functions evaluated client-side.
DateRangePartition	A single date range partition with non-overlapping boundaries.
DateRangePartitioner	Generates non-overlapping date range partitions for splitting aggregate queries
DeleteColumnRequest	Request to delete a column (attribute) from a Dataverse table.
DeleteDryRunResult	Result of a delete dry-run operation, listing dependencies that would block deletion.
DeleteGlobalChoiceRequest	Request to delete a global choice (option set) from Dataverse.
DeleteKeyRequest	Request to delete an alternate key from a Dataverse table.
DeleteOptionValueRequest	Request to delete an option value from an option set.
DeleteRelationshipRequest	Request to delete a Dataverse relationship.
DeleteTableRequest	Request to delete a Dataverse table (entity).
DependencyInfo	Describes a single component dependency found during a delete dry-run.
DistinctNode	Deduplicates rows from a single input using a composite key hash set.
DmlExecuteNode	Executes DML operations (INSERT, UPDATE, DELETE) using BulkOperationExecutor.
DmlValueCoercer	Coerces raw CLR values from SQL DML into Dataverse SDK-typed values
EntityDataProvider	Developers can register plug-ins on a data provider to enable data access for virtual entities in the system.
EntityKeyDto	Represents an alternate key definition for an entity.
EntityMetadataDto	Full entity metadata including attributes, relationships, keys, and privileges.
EntityRelationshipsDto	Container for all relationship types for an entity.
EntitySummary	Summary information for an entity in list views.
EnvironmentResolver	Resolves named environments from DataverseOptions.
EnvironmentVariableDefinition	Contains information about the settable variable: its type, default value, and etc.
EnvironmentVariableValue	Holds the value for the associated EnvironmentVariableDefinition entity.
ErrorFunctions	T-SQL error functions for TRY/CATCH blocks.
FetchXmlScanNode	Executes a FetchXML query and yields rows page-by-page.
FunctionRegistry	Registry of scalar functions available for expression evaluation.
ImportJob	For internal use only.
JsonFunctions	T-SQL JSON functions evaluated client-side using System.Text.Json.
LeastConnectionsStrategy	Selects the connection with the fewest active clients.
ListResult<T>	Wraps a list result with metadata about the total dataset.
ManyToManyRelationshipDto	Represents a many-to-many relationship.
MathFunctions	T-SQL math functions evaluated client-side.
MergeAggregateColumn	Describes an aggregate column to be merged.
MergeAggregateNode	Merges partial aggregate results from parallel partitions.
MetadataErrorCodes	Machine-readable error codes for metadata authoring validation failures.
MetadataQueryExecutor	Queries Dataverse metadata via PPDS.Dataverse.Metadata.IMetadataQueryService and returns results
MetadataScanNode	Scan node that queries Dataverse metadata API instead of entity data.
MetadataTableDefinitions	Defines the schema of metadata virtual tables.
MetadataValidationException	Thrown when metadata authoring validation fails.
NodeStatistics	Statistics for a single plan node. Thread-safe via Interlocked operations.
NullFunctions	T-SQL null-handling functions evaluated client-side.
OptionDefinition	Defines a single option value for a choice or choices column.
OptionSetMetadataDto	Full option set metadata including all values.
OptionSetSummary	Summary information for a global option set in list views.
OptionValueDto	Represents a single option value in an option set.
ParallelPartitionNode	Executes child plan nodes in parallel, limited by pool capacity.
PlanExecutor	Executes a query plan by consuming the root node's IAsyncEnumerable
PlanFormatter	Formats an execution plan tree as indented text for EXPLAIN output.
PluginAssembly	Assembly that contains one or more plug-in types.
PluginTraceLog	Trace and exception information generated by plug-ins and custom workflow activities.
PluginType	Type that inherits from the IPlugin interface and is contained within a plug-in assembly.
PoolExhaustedException	Exception thrown when the connection pool is exhausted and no connection
PoolStatistics	Statistics and health information for the connection pool.
PooledClientExtensions	Extension methods on PPDS.Dataverse.Pooling.IPooledClient for common Dataverse SDK operations
PrefetchScanNode	Wraps any IQueryPlanNode to speculatively prefetch rows into a bounded buffer.
PrivilegeDto	Represents a security privilege for an entity.
ProgressSnapshot	Immutable snapshot of progress state at a point in time.
ProgressTracker	Thread-safe progress tracker for bulk operations.
ProjectColumn	Defines a column in a ProjectNode's output.
ProjectNode	Maps input rows to output rows (column selection, renaming, expression evaluation).
Publisher	A publisher of a CRM solution.
QueryColumn	Represents a column in a query result with its metadata.
QueryErrorCode	Structured error codes for query execution failures.
QueryExecutionException	Exception thrown during query plan execution with a structured error code.
QueryExecutor	Executes FetchXML queries against Dataverse using the connection pool.
QueryPlanContext	Shared context for plan execution: pool, cancellation, statistics.
QueryPlanDescription	Describes an execution plan for display (EXPLAIN output).
QueryPlanOptions	Options for query plan construction.
QueryPlanResult	The result of building an execution plan: the root plan node plus metadata
QueryPlanStatistics	Mutable statistics collected during plan execution.
QueryResult	Represents the result of a query execution against Dataverse.
QueryRow	A single row flowing through the plan. Lightweight wrapper around column values.
QueryValue	Represents a value in a query result, including both the raw value
ReactivateKeyRequest	Request to reactivate a failed alternate key on a Dataverse table.
RelationshipMetadataDto	Represents a one-to-many or many-to-one relationship.
RemoteScanNode	Executes a FetchXML query against a remote environment's connection pool.
ReorderOptionsRequest	Request to reorder the option values in an option set.
ResilienceOptions	Configuration options for resilience and retry behavior.
Role	Grouping of security privileges. Users are assigned roles that authorize their access to the Microsoft CRM system.
RoundRobinStrategy	Simple round-robin rotation through available connections.
SchemaValidator	Validates metadata authoring requests before SDK calls.
SdkMessage	Message that is supported by the SDK.
SdkMessageFilter	Filter that defines which SDK messages are valid for each type of entity.
SdkMessageProcessingStep	Stage in the execution pipeline that a plug-in is to execute.
SdkMessageProcessingStepImage	Copy of an entity's attributes before or after the core system operation.
SecretResolver	Resolves secrets from various sources.
SeedInitializationResult	Result of initializing a seed connection for a pool source.
SensitiveDataAttribute	Marks a property or field as containing sensitive data that should not be logged or displayed.
ServiceClientSource	Connection source for pre-authenticated ServiceClients.
ServiceCollectionExtensions	Extension methods for configuring Dataverse services in an Microsoft.Extensions.DependencyInjection.IServiceCollection.
ServiceEndpoint	Service endpoint that can be contacted.
ServiceProtectionException	Exception thrown when a service protection limit is hit.
Solution	A solution which contains CRM customizations.
SolutionComponent	A component of a CRM solution.
SqlCursorContextResult	Result of cursor context analysis for SQL IntelliSense.
StringFunctions	T-SQL string functions evaluated client-side.
SystemUser	Person with access to the Microsoft CRM system and who owns objects in the Microsoft CRM database.
TdsCompatibilityChecker	Determines whether a SQL query can be executed via the Dataverse TDS Endpoint.
TdsQueryExecutor	Executes SQL queries against Dataverse's TDS Endpoint using the SQL Server wire protocol.
TdsScanNode	Executes a SQL query directly against the Dataverse TDS Endpoint.
ThrottleAwareStrategy	Avoids throttled connections and falls back to round-robin among available connections.
ThrottleState	Represents the throttle state for a connection.
ThrottleTracker	Tracks throttle state for connections using a thread-safe concurrent dictionary.
TranspileResult	Result of SQL to FetchXML transpilation, including virtual column metadata.
UpdateColumnRequest	Request to update an existing column (attribute) on a Dataverse table.
UpdateGlobalChoiceRequest	Request to update an existing global choice (option set) in Dataverse.
UpdateOptionValueRequest	Request to update an existing option value in an option set.
UpdateRelationshipRequest	Request to update an existing Dataverse relationship.
UpdateStateValueRequest	Request to update a state or status option value label.
UpdateTableRequest	Request to update an existing Dataverse table (entity).
ValidationMessage	Represents a validation message produced during a dry-run or schema authoring operation.
VariableScope	Manages SQL variable declarations and values.
VirtualColumnInfo	Information about a virtual column (e.g., "owneridname" that maps to "ownerid").
WebResource	Data equivalent to files used in Web development. Web resources provide client-side components that are used to provide custom user interface elements.
WindowDefinition	Defines a single window function to compute within a ClientWindowNode.
Workflow	Set of logical rules that define the steps necessary to automate a specific business process, task, or set of actions to be performed.

Records

Type	Summary
BulkOperationResult	Result of a bulk operation.
CompiledOrderByItem	A compiled ORDER BY item used by window functions. Contains the column name for
CompiledSetClause	A compiled SET clause for UPDATE statements.
QueryExecutionOptions	Per-query execution options that affect how the query is sent to Dataverse.
SqlCompletion	A single completion item for SQL IntelliSense.
SqlDiagnostic	A diagnostic message for a region of SQL text (error, warning, or info).
VariableInfo	Information about a declared SQL variable.

Structs

Type	Summary
SourceToken	A token with position and classification for syntax highlighting.

Enums

Type	Summary
AggregateFunction	Aggregate functions supported by MergeAggregateNode.
CascadeBehavior	Defines the cascade behavior options for entity relationship actions.
ClientAggregateFunction	Aggregate functions supported by ClientAggregateNode.
ConnectionSelectionStrategy	Strategy for selecting which connection to use from the pool.
CustomLogicBypass	Specifies which custom business logic to bypass during bulk operations.
DataverseAuthType	Authentication type for Dataverse connections.
DmlOperation	The type of DML operation.
OAuthLoginPrompt	OAuth login prompt behavior.
QueryColumnType	Represents the data type of a column in a query result.
SchemaColumnType	Defines the supported column types for schema authoring operations.
SeedFailureReason	Categorized reasons for seed initialization failure.
SourceTokenType	Language-agnostic source token classification for syntax highlighting.
SqlCompletionContextKind	The kind of completion context at a cursor position in SQL text.
SqlCompletionKind	The kind of completion item in SQL IntelliSense results.
SqlDiagnosticSeverity	Severity level for SQL diagnostics.
TdsCompatibility	Result of a TDS Endpoint compatibility check.
asyncoperation_operationtype	Type of the system job.
asyncoperation_statecode	Status of the system job.
asyncoperation_statuscode	Reason for the status of the system job.
componentstate	The state of this component.
componenttype	All of the possible component types for solutions.
connectionreference_promptingbehavior	This field configures how this connection reference gets prompted
connectionreference_statecode	Status of the Connection Reference
connectionreference_statuscode	Reason for the status of the Connection Reference
customapi_allowedcustomprocessingsteptype	The Allowed Custom Processing Step Type
customapi_statecode	Status of the Custom API
customapi_statuscode	Reason for the status of the Custom API
customapifieldtype	Custom API Field Types
customapirequestparameter_statecode	Status of the Custom API Request Parameter
customapirequestparameter_statuscode	Reason for the status of the Custom API Request Parameter
customapiresponseproperty_statecode	Status of the Custom API Response Property
customapiresponseproperty_statuscode	Reason for the status of the Custom API Response Property
environmentvariabledefinition_secretstore	The secret store where the secret is persisted.
environmentvariabledefinition_statecode	Status of the Environment Variable Definition
environmentvariabledefinition_statuscode	Reason for the status of the Environment Variable Definition
environmentvariablevalue_statecode	Status of the Environment Variable Value
environmentvariablevalue_statuscode	Reason for the status of the Environment Variable Value
isinherited	The role is inherited
pluginassembly_authtype	Authentication Type for the Web sources like AzureWebApp, for example 0=BasicAuth
pluginassembly_isolationmode	Information about how the plugin assembly is to be isolated at execution time; None / Sandboxed / External.
pluginassembly_sourcetype	Location of the assembly, for example 0=database, 1=on-disk, 2=Normal, 3=AzureWebApp.
pluginpackage_statecode	Status of the Plugin Package
pluginpackage_statuscode	Reason for the status of the Plugin Package
plugintracelog_mode	Type of Execution
plugintracelog_operationtype	Type of Plugin
publisher_address1_addresstypecode	Type of address for address 1, such as billing, shipping, or primary address.
publisher_address1_shippingmethodcode	Method of shipment for address 1.
publisher_address2_addresstypecode	Type of address for address 2. such as billing, shipping, or primary address.
publisher_address2_shippingmethodcode	Method of shipment for address 2.
sdkmessageprocessingstep_invocationsource	Identifies if a plug-in should be executed from a parent pipeline, a child pipeline, or both.
sdkmessageprocessingstep_mode	Run-time mode of execution, for example, synchronous or asynchronous.
sdkmessageprocessingstep_stage	Stage in the execution pipeline that the SDK message processing step is in.
sdkmessageprocessingstep_statecode	Status of the SDK message processing step.
sdkmessageprocessingstep_statuscode	Reason for the status of the SDK message processing step.
sdkmessageprocessingstep_supporteddeployment	Deployment that the SDK message processing step should be executed on; server, client, or both.
sdkmessageprocessingstepimage_imagetype	Type of image requested.
securityrole_isautoassigned	Value indicating whether security role is auto-assigned based on user license
serviceendpoint_authtype	Authentication type for Service Bus
serviceendpoint_connectionmode	Connection mode.
serviceendpoint_contract	Contract type.
serviceendpoint_messagecharset	Character encoding used for messages sent to a service endpoint
serviceendpoint_messageformat	Format type.
serviceendpoint_namespaceformat	Format for Service Bus Namespace
serviceendpoint_schematype	Schema type for Event Grid
serviceendpoint_userclaim	User claim value type.
solution_solutiontype	All possible types of solution
solutioncomponent_rootcomponentbehavior	Indicates the include behavior of the root component.
systemuser_accessmode	Type of user.
systemuser_address1_addresstypecode	Type of address for address 1, such as billing, shipping, or primary address.
systemuser_address1_shippingmethodcode	Method of shipment for address 1.
systemuser_address2_addresstypecode	Type of address for address 2, such as billing, shipping, or primary address.
systemuser_address2_shippingmethodcode	Method of shipment for address 2.
systemuser_azurestate	Azure state of user.
systemuser_caltype	License type of user. This is used only in the on-premises version of the product. Online licenses are managed through Microsoft 365 Office Portal.
systemuser_deletestate	User delete state.
systemuser_emailrouteraccessapproval	Indicates the approval options for server-side synchronization or Email Router access.
systemuser_incomingemaildeliverymethod	Incoming email delivery method for the user.
systemuser_invitestatuscode	User invitation status.
systemuser_outgoingemaildeliverymethod	Outgoing email delivery method for the user.
systemuser_preferredaddresscode	Preferred address for the user.
systemuser_preferredemailcode	Preferred email address for the user.
systemuser_preferredphonecode	Preferred phone number for the user.
systemuser_systemmanagedusertype	The type of user
workflow_businessprocesstype	Business Process Type.
workflow_category	Category of the process.
workflow_mode	Mode of the process.
workflow_modernflowtype	Type of the Modern Flow process.
workflow_runas	Specifies the system user account under which a workflow executes
workflow_scope	Workflow scope.
workflow_stage	Stage in which the Workflow executes
workflow_statecode	Status of the workflow
workflow_statuscode	Reason for the status of the workflow
workflow_throttlingbehaviortype	Type of workflow throttling behavior.
workflow_type	Workflow type.
workflow_uiflowtype	Type of the UI Flow process.