Skip to main content

sql

Execute a SQL query against Dataverse (transpiled to FetchXML)

Usage​

ppds query sql [options]

Arguments​

NameRequiredDescription
sqlyesSQL query string. Can be omitted if using --file or --stdin.

Options​

LongShortTypeDefaultDescription
--confirmboolConfirm DML execution without interactive prompt
--correlation-idstringCorrelation ID for distributed tracing
--count-cboolInclude total record count in results
--debugboolShow trace-level diagnostic output
--dry-runboolShow the execution plan without running the DML statement
--environment-envstringOverride the environment URL. Takes precedence over profile's bound environment.
--explainboolShow the execution plan without executing the query
--fileFileInfoRead SQL from a file
--no-limitboolRemove the 10,000 row safety cap for DML operations
--output-format-fOutputFormatOutput format
--pageint?Page number (1-based) for paged results
--paging-cookiestringPaging cookie from previous query for continuation
--profile-pstringAuthentication profile name
--quiet-qboolShow only warnings and errors
--show-fetchxmlboolOutput the transpiled FetchXML instead of executing the query
--stdinboolRead SQL from standard input
--tdsboolRoute query through the TDS Endpoint (direct SQL) instead of FetchXML
--top-tint?Limit the number of results returned
--verbose-vboolShow detailed output including debug messages