The [[Microsoft TDS Protocol]] is the protocol used to interact between client applications (such as Microsoft Access) and Invantive UniversalSQL Server. For analysis purposes, it may be necessary to trace the data exchanged using the TDS protocol.
## Example
The following JSON is an example for this standardized configuration component:
```json
{ //
// Whether to trace TDS as NDJSON.
//
"TdsTraceAsNdJson": false
//
// Maximum length of TDS trace contents.
// When the output is longer, the center will be replaced by ellipsis.
//
, "MaxTdsTraceContentsLength": 20000
//
// Whether to log TDS trace text to console.
//
, "ConsoleText": true
//
// Whether to log TDS trace errors to console.
//
, "ConsoleError": true
//
// Whether to log TDS trace protocol to console.
//
, "ConsoleProtocol": true
//
// Whether to log TDS trace row data to console.
//
, "ConsoleRowData": false
//
// Whether to log TDS trace row metadata to console.
//
, "ConsoleRowMetadata": false
//
// Whether to log TDS trace wire messages to console.
//
, "ConsoleWire": false
, "ConsolePacketTypeUnknown": false
, "ConsolePacketTypeSqlBatch": false
, "ConsolePacketTypeRpcRequest": true
, "ConsolePacketTypeTabularResult": false
, "ConsolePacketTypeAttention": false
, "ConsolePacketTypeBulkLoad": false
, "ConsolePacketTypeFedAuthToken": false
, "ConsolePacketTypeTransactionManager": false
, "ConsolePacketTypeLogin7": false
, "ConsolePacketTypeSSPI": false
, "ConsolePacketTypePreLogin": false
//
// Whether to log TDS trace text to Invantive trace.
//
, "TraceText": true
//
// Whether to log TDS trace errors to Invantive trace.
//
, "TraceError": true
//
// Whether to log TDS trace protocol to Invantive trace.
//
, "TraceProtocol": true
//
// Whether to log TDS trace row data to Invantive trace.
//
, "TraceRowData": false
//
// Whether to log TDS trace row metadata to Invantive trace.
//
, "TraceRowMetadata": false
//
// Whether to log TDS trace wire messages to Invantive trace.
//
, "TraceWire": false
, "TracePacketTypeUnknown": false
, "TracePacketTypeSqlBatch": false
, "TracePacketTypeRpcRequest": false
, "TracePacketTypeTabularResult": false
, "TracePacketTypeAttention": false
, "TracePacketTypeBulkLoad": false
, "TracePacketTypeFedAuthToken": false
, "TracePacketTypeTransactionManager": false
, "TracePacketTypeLogin7": false
, "TracePacketTypeSSPI": false
, "TracePacketTypePreLogin": false
}
```
## Definition
```json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "TdsTraceConfig.schema.json",
"title": "TdsTraceConfig",
"description": "TDS trace configuration.",
"type": "object",
"additionalProperties": false,
"properties": {
"TdsTraceAsNdJson": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace as NDJSON."
},
"MaxTdsTraceContentsLength": {
"type": [
"integer",
"null"
],
"default": 2000,
"description": "Maximum length of TDS trace contents."
},
"ConsoleText": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace text to console."
},
"ConsoleError": {
"type": "boolean",
"default": true,
"description": "Whether to log TDS trace errors to console."
},
"ConsoleProtocol": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace protocol information to console."
},
"ConsoleRowData": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace row data to console."
},
"ConsoleRowMetadata": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace row metadata to console."
},
"ConsoleWire": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace wire data to console."
},
"ConsolePacketTypeUnknown": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace packet type unknown to console."
},
"ConsolePacketTypeTabularResult": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace tabular result packets to console."
},
"ConsolePacketTypeRpcRequest": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace RPC request packets to console."
},
"ConsolePacketTypeSqlBatch": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace SQL batch packets to console."
},
"ConsolePacketTypeLogin7": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace LOGIN7 packets to console."
},
"ConsolePacketTypeSSPI": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace SSPI packets to console."
},
"ConsolePacketTypePreLogin": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace pre-login packets to console."
},
"ConsolePacketTypeFedAuthToken": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace federated authentication token packets to console."
},
"ConsolePacketTypeTransactionManager": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace transaction manager packets to console."
},
"ConsolePacketTypeAttention": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace attention packets to console."
},
"ConsolePacketTypeBulkLoad": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace bulk load packets to console."
},
"TraceText": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace text to trace output."
},
"TraceError": {
"type": "boolean",
"default": true,
"description": "Whether to log TDS trace errors to trace output."
},
"TraceProtocol": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace protocol information to trace output."
},
"TraceRowData": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace row data to trace output."
},
"TraceRowMetadata": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace row metadata to trace output."
},
"TraceWire": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace wire data to trace output."
},
"TracePacketTypeUnknown": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace packet type unknown to trace output."
},
"TracePacketTypeTabularResult": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace tabular result packets to trace output."
},
"TracePacketTypeRpcRequest": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace RPC request packets to trace output."
},
"TracePacketTypeSqlBatch": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace SQL batch packets to trace output."
},
"TracePacketTypeFedAuthToken": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace federated authentication token packets to trace output."
},
"TracePacketTypeBulkLoad": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace bulk load packets to trace output."
},
"TracePacketTypeAttention": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace attention packets to trace output."
},
"TracePacketTypeSSPI": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace SSPI packets to trace output."
},
"TracePacketTypeLogin7": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace LOGIN7 packets to trace output."
},
"TracePacketTypeTransactionManager": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace transaction manager packets to trace output."
},
"TracePacketTypePreLogin": {
"type": "boolean",
"default": false,
"description": "Whether to log TDS trace pre-login packets to trace output."
}
}
}
```