# SearchResultsByQuery ## Documentation The rows, sheets, reports, dashboards, folders, workspaces, discussions and attachments whose text matches a search. - Catalog: `Smartsheet` - Schema: `Platform` This is a read-only table function. The Smartsheet API may not support changing the data or the Invantive UniversalSQL driver for Smartsheet does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Smartsheet API. ## Parameters of Table Function The following parameters can be used to control the behaviour of the table function `SearchResultsByQuery`. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values. Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three. Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third. | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `query` | `varchar2` | ☑ | | The text to search for. | ## Columns of Table Function The columns of the table function `SearchResultsByQuery` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `context_data` | `varchar2` | | ☐ | More text around the match, separated by a line break. | | `object_id` | `int64` | | ☑ | The id of what was found. | | `object_type` | `varchar2` | | ☑ | What was found: row, sheet, report, sight, folder, workspace, discussion, attachment, summaryField or template. | | `parent_object_id` | `int64` | | ☐ | The id of what it is in. | | `parent_object_name` | `varchar2` | | ☐ | The name of what it is in. | | `parent_object_type` | `varchar2` | | ☐ | What it is in, such as the sheet of a row. | | `text` | `varchar2` | | ☐ | The text that matched. |