Class ExecuteResearchQueryAction

Action that executes read-only SQL SELECT queries for research purposes with security validation.

Security Features:

SELECT-only enforcement (rejects INSERT, UPDATE, DELETE, DROP, etc.)
Dangerous operation detection (EXEC, xp_, sp_, dynamic SQL, etc.)
Query timeout protection
Audit logging of all queries
Result size limiting

Performance Features:

Configurable row limits to prevent overwhelming results
Execution time tracking
Validation warnings for potentially slow queries

Note: SQL syntax validation is handled by SQL Server during execution. This provides more accurate error messages than a JavaScript parser.

Example

// Simple SELECT query
await runAction({
  ActionName: 'Execute Research Query',
  Params: [{
    Name: 'Query',
    Value: 'SELECT TOP 100 * FROM Customers WHERE Country = ''USA'''
  }]
});

// Query with timeout
await runAction({
  ActionName: 'Execute Research Query',
  Params: [{
    Name: 'Query',
    Value: 'SELECT COUNT(*) FROM Orders GROUP BY CustomerID'
  }, {
    Name: 'Timeout',
    Value: 60
  }]
});

Hierarchy (view full)

BaseAction
- ExecuteResearchQueryAction

Index

Constructors

constructor

new ExecuteResearchQueryAction(): ExecuteResearchQueryAction
Returns ExecuteResearchQueryAction
Inherited from BaseAction.constructor

Properties

`Private` `Readonly` DANGEROUS_PATTERNS

DANGEROUS_PATTERNS: RegExp[] = ...

List of dangerous SQL keywords and patterns that should be blocked

Methods

`Protected` InternalRunAction

InternalRunAction(params): Promise<ActionResultSimple>
Internal method that must be implemented by derived action classes. This is where the actual action logic should be implemented.
Parameters
- params: RunActionParams<any>
  The action execution parameters including typed context
Returns Promise<ActionResultSimple>
Promise resolving to the action result
Overrides BaseAction.InternalRunAction
- Defined in CoreActions/src/custom/data/execute-research-query.action.ts:87

Run

Run(params): Promise<ActionResultSimple>
Executes the action with the provided parameters.
Parameters
- params: RunActionParams<any>
  The action execution parameters including context
Returns Promise<ActionResultSimple>
Promise resolving to the action result
Inherited from BaseAction.Run
- Defined in Engine/dist/generic/BaseAction.d.ts:37

`Private` analyzeQueryData

analyzeQueryData(results, columns, analysisRequest, params, columnMaxLength?): Promise<{
    analysis?: string;
    error?: string;
    success: boolean;
}>
Analyze query data using AI prompt
Parameters
- results: any[]
- columns: {
      ColumnName: string;
      DataType: string;
      IsNullable: boolean;
  }[]
- analysisRequest: string
- params: RunActionParams<any>
- columnMaxLength: number = 0
Returns Promise<{
    analysis?: string;
    error?: string;
    success: boolean;
}>
- Defined in CoreActions/src/custom/data/execute-research-query.action.ts:432

`Private` buildDetailedMessage

buildDetailedMessage(results, columns, executionTimeMs, totalTimeMs, wasTruncated, warnings, returnType, formattedData?, analysis?): string
Build detailed message with query results for agent consumption
Parameters
- results: any[]
- columns: {
      ColumnName: string;
      DataType: string;
      IsNullable: boolean;
  }[]
- executionTimeMs: number
- totalTimeMs: number
- wasTruncated: boolean
- warnings: string[]
- returnType: string
- Optional formattedData: string
- Optional analysis: string
Returns string
- Defined in CoreActions/src/custom/data/execute-research-query.action.ts:530

`Private` ensureRowLimit

ensureRowLimit(query, maxRows): string
Ensures query has a row limit to prevent overwhelming results
Parameters
- query: string
- maxRows: number
Returns string
- Defined in CoreActions/src/custom/data/execute-research-query.action.ts:301

`Private` formatAsCSV

formatAsCSV(results, columnMaxLength?): string
Formats results as CSV string with proper escaping
Parameters
- results: any[]
  Array of result objects
- columnMaxLength: number = 0
  Optional maximum length for column values (0 = no limit)
Returns string
- Defined in CoreActions/src/custom/data/execute-research-query.action.ts:356

`Private` formatCSVRow

formatCSVRow(values): string
Formats a single CSV row (for headers)
Parameters
- values: string[]
Returns string
- Defined in CoreActions/src/custom/data/execute-research-query.action.ts:383

`Private` formatCSVValue

formatCSVValue(value): string
Formats a single CSV value with proper escaping
- Null/undefined values become empty strings
- All string values are quoted and escaped
- Numbers and booleans are converted to strings and quoted
Parameters
- value: any
Returns string
- Defined in CoreActions/src/custom/data/execute-research-query.action.ts:393

`Private` generateValidationWarnings

generateValidationWarnings(query, rowCount, executionTimeMs): string[]
Generates validation warnings for potentially problematic queries
Parameters
- query: string
- rowCount: number
- executionTimeMs: number
Returns string[]
- Defined in CoreActions/src/custom/data/execute-research-query.action.ts:321

`Private` getNumericParam

getNumericParam(params, paramName, defaultValue): number
Helper to get numeric parameter value
Parameters
- params: RunActionParams<any>
- paramName: string
- defaultValue: number
Returns number
- Defined in CoreActions/src/custom/data/execute-research-query.action.ts:515

`Private` getPromptByNameAndCategory

getPromptByNameAndCategory(name, category): AIPromptEntityExtended
Get prompt by name and category from AIEngine
Parameters
- name: string
- category: string
Returns AIPromptEntityExtended
- Defined in CoreActions/src/custom/data/execute-research-query.action.ts:494

`Private` getStringParam

getStringParam(params, paramName): string
Helper to get string parameter value
Parameters
- params: RunActionParams<any>
- paramName: string
Returns string
- Defined in CoreActions/src/custom/data/execute-research-query.action.ts:504

`Private` trimResultColumns

trimResultColumns(results, maxLength): any[]
Trims columns in result set to maximum length Used for JSON format results to prevent verbose fields from overwhelming context
Parameters
- results: any[]
  Array of result objects
- maxLength: number
  Maximum length for string values
Returns any[]
New array with trimmed values
- Defined in CoreActions/src/custom/data/execute-research-query.action.ts:415

`Private` validateQuerySecurity

validateQuerySecurity(query): {
    isValid: boolean;
    message?: string;
    resultCode?: string;
}
Validates query for security concerns
Parameters
- query: string
Returns {
    isValid: boolean;
    message?: string;
    resultCode?: string;
}
- isValid: boolean
- Optional message?: string
- Optional resultCode?: string
- Defined in CoreActions/src/custom/data/execute-research-query.action.ts:270

Class ExecuteResearchQueryAction

Example

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns ExecuteResearchQueryAction

Properties

Private Readonly DANGEROUS_PATTERNS

Methods

Protected InternalRunAction

Parameters

Returns Promise<ActionResultSimple>

Run

Parameters

Returns Promise<ActionResultSimple>

Private analyzeQueryData

Parameters

Returns Promise<{ analysis?: string; error?: string; success: boolean; }>

Private buildDetailedMessage

Parameters

Returns string

Private ensureRowLimit

Parameters

Returns string

Private formatAsCSV

Parameters

Returns string

Private formatCSVRow

Parameters

Returns string

Private formatCSVValue

Parameters

Returns string

Private generateValidationWarnings

Parameters

Returns string[]

Private getNumericParam

Parameters

Returns number

Private getPromptByNameAndCategory

Parameters

Returns AIPromptEntityExtended

Private getStringParam

Parameters

Returns string

Private trimResultColumns

Parameters

Returns any[]

Private validateQuerySecurity

Parameters

Returns { isValid: boolean; message?: string; resultCode?: string; }

isValid: boolean

Optional message?: string

Optional resultCode?: string

Settings

Member Visibility

Theme

On This Page

`Private` `Readonly` DANGEROUS_PATTERNS

`Protected` InternalRunAction

`Private` analyzeQueryData

Returns Promise<{
analysis?: string;
error?: string;
success: boolean;
}>

`Private` buildDetailedMessage

`Private` ensureRowLimit

`Private` formatAsCSV

`Private` formatCSVRow

`Private` formatCSVValue

`Private` generateValidationWarnings

`Private` getNumericParam

`Private` getPromptByNameAndCategory

`Private` getStringParam

`Private` trimResultColumns

`Private` validateQuerySecurity

Returns {
isValid: boolean;
message?: string;
resultCode?: string;
}

`Optional` message?: string

`Optional` resultCode?: string