surveilr_function_doc (table) Content
- Start Row: 0
- Rows per Page: 50
- Total Rows: 27
- Current Page: 1
- Total Pages: 1
| surveilr_anonymize_email | Anonymizes an email address by replacing the local part with a pseudonym. | [{"name":"email","data_type":"","description":"`String` - The email address to anonymize."}] | `String` - The anonymized email address. | 1.0.0 |
| surveilr_mask_financial | Masks a financial number, such as a credit card or bank account number, with asterisks except for the last four digits. | [{"name":"value","data_type":"","description":"`String` - The financial number to mask."}] | `String` - The masked financial number. | 1.0.0 |
| surveilr_anonymize_date | Anonymizes a date by randomizing the day within a safe range. | [{"name":"date","data_type":"","description":"`String` - The date to anonymize in `YYYY-MM-DD` format."}] | `String` - The anonymized date. | 1.0.0 |
| surveilr_mask_phone | Masks a phone number by replacing the middle digits with asterisks. | [{"name":"phone","data_type":"","description":"`String` - The phone number to mask."}] | `String` - The masked phone number. | 1.0.0 |
| surveilr_mask_dob | Masks a date of birth (DOB) by preserving only the year and replacing other fields with asterisks. | [{"name":"dob","data_type":"","description":"`String` - The date of birth to mask in `YYYY-MM-DD` format."}] | `String` - The masked date of birth. | 1.0.0 |
| surveilr_mask_address | Masks an address by obscuring parts of the street and city with asterisks. | [{"name":"address","data_type":"","description":"`String` - The address to mask."}] | `String` - The masked address. | 1.0.0 |
| surveilr_hash | Generates a SHA1 hash for a given input string. | [{"name":"value","data_type":"","description":"`String` - The string to hash."}] | `String` - The hexadecimal representation of the hash. | 1.0.0 |
| surveilr_device_id | Generates a unique device ID for the system. | [] | `String` - A unique device ID. | 1.0.0 |
| surveilr_version | Returns the current version of the system and its dependencies. | [] | `String` - A JSON-formatted string containing the system version and dependencies. | 1.0.0 |
| surveilr_ensure_function | Ensures that specific SQLite functions are registered and returns error messages if not found. | [{"name":"func1","data_type":"","description":"`String` - The name of the first function to check."},{"name":"msg1","data_type":"","description":"`String` - The error message if `func1` is not found."},{"name":"func2","data_type":"","description":"`String` (optional) - The name of the second function to check."},{"name":"msg2","data_type":"","description":"`String` (optional) - The error message if `func2` is not found."}] | `bool` - Returns `true` if all functions are present, otherwise throws an error. | 1.5.3 |
| surveilr_ensure_extension | Ensures that specific SQLite extensions are loaded into the current connection.Dynamically loads extensions if they are not already available. | [{"name":"ext1","data_type":"","description":"`String` - The name or path of the first extension to load."},{"name":"ext2","data_type":"","description":"`String` (optional) - The name or path of the second extension to load."}] | `bool` - Returns `true` if all extensions are successfully loaded. | 1.5.3 |
| surveilr_orchestration_context_session_id | Returns the current orchestration session ID for the context. | [] | `Option<String>` - The orchestration session ID or `None` if unavailable. | 1.0.0 |
| surveilr_ingest_session_id | Generates or retrieves the current ingestion session ID. | [] | `String` - The ingestion session ID. | 1.0.0 |
| surveilr_orchestration_nature_id | Retrieves the ID for a given orchestration nature. | [{"name":"orchestration_nature","data_type":"","description":"`String` - The nature of orchestration."}] | `Option<String>` - The orchestration nature ID or `None` if unavailable. | 1.0.0 |
| surveilr_ensure_orchestration_nature | Ensures that an orchestration nature exists, creating it if necessary. | [{"name":"id","data_type":"","description":"`String` - The ID of the orchestration nature."},{"name":"nature","data_type":"","description":"`String` - The description of the orchestration nature."},{"name":"precomputed_id","data_type":"","description":"`String` (optional) - A precomputed ID to use."}] | `Option<String>` - The orchestration nature ID or `None` if unavailable. | 1.0.0 |
| surveilr_get_orchestration_session_info | Retrieves information about an orchestration session, including session ID and entry ID. | [{"name":"orchestration_session_id","data_type":"","description":"`String` - The ID of the orchestration session."}] | `String` - A JSON string containing the session and entry information. | 1.0.0 |
| surveilr_orchestration_session_append_exec | Appends an execution log entry to an orchestration session. | [{"name":"orchestration_session_id","data_type":"","description":"`String` - The ID of the orchestration session."},{"name":"exec_nature","data_type":"","description":"`String` - The nature of the execution."},{"name":"exec_code","data_type":"","description":"`u64` - The code associated with the execution."},{"name":"exec_status","data_type":"","description":"`String` - The status of the execution."},{"name":"input_text","data_type":"","description":"`Option<String>` - Optional text input associated with the execution."}] | `String` - The ID of the appended execution log entry. | 1.0.0 |
| surveilr_orchestration_session_append_log | Appends a log entry to an orchestration session. | [{"name":"category","data_type":"","description":"`String` - The category of the log entry."},{"name":"content","data_type":"","description":"`String` - The content of the log entry."}] | `String` - The ID of the appended log entry. | 1.0.0 |
| surveilr_assert_tabular_object | Verifies whether a table or view with the given name exists in the database. | [{"name":"name","data_type":"","description":"`String` - The name of the table or view to check."}] | `bool` - `true` if the table or view exists, `false` otherwise. | 1.0.0 |
| surveilr_assert_tabular_column | Verifies whether a table or view contains all the specified columns. | [{"name":"name","data_type":"","description":"`String` - The name of the table or view to check."},{"name":"columns","data_type":"","description":"`Vec<String>` - A list of column names to verify."}] | `bool` - `true` if all columns exist, `false` otherwise. | 1.0.0 |
| surveilr_anonymize_name | Generates a pseudonym for a given name. | [{"name":"name","data_type":"","description":"`Option<String>` - The name to anonymize."}] | `String` - The anonymized name or "NULL" if no input is provided. | 1.0.0 |
| surveilr_mask | Masks the input value with asterisks. | [{"name":"value","data_type":"","description":"`Option<String>` - The value to mask."}] | `String` - A masked string or "NULL" if no input is provided. | 1.0.0 |
| surveilr_generalize_age | Generalizes an age into predefined age ranges. | [{"name":"age","data_type":"","description":"`i32` - The age to generalize."}] | `String` - The generalized age range (e.g., "0-18", "19-35"). | 1.0.0 |
| surveilr_function_docs | A virtual table that provides details about surveilr SQlite Functions.It reads function details from the `surveilr` binary and returns them in a tabular format.- `name`: `TEXT` - The name of the function.- `description`: `TEXT` - A description of the function.- `parameters`: `JSON` - A JSON string detailing the function's parameters.- `return_type`: `TEXT` - The return type of the function.- `version`: `TEXT` - The version in which the function was introduced. | [] | 1.5.4 | |
| surveilr_udi_dal_fs | Registers a virtual table module `surveilr_udi_dal_fs` that interacts with files using the OpenDAL file system operator.This virtual table allows structured querying of file metadata, such as name, path, size, content, and other details,for files within a specified directory. The table also supports filtering by a specific path.The virtual table exposes the following columns:- `name`: `TEXT` - The name of the file.- `path`: `TEXT` - The full path of the file.- `last_modified`: `TEXT` - The last modified timestamp of the file in ISO 8601 format.- `content`: `BLOB` - The binary content of the file (optional).- `size`: `INTEGER` - The size of the file in bytes.- `content_type`: `TEXT` - The MIME type of the file (e.g., `text/plain`, `image/jpeg`).- `digest`: `TEXT` - The MD5 hash of the file content (optional).- `arg_path`: `HIDDEN TEXT` - The base path used for filtering (required for queries). | [] | `A table` - | `1.5.4` |
| surveilr_udi_dal_s3 | Registers a virtual table module `surveilr_udi_dal_fs` that interacts with files from an S3 bucket.This virtual table allows structured querying of file metadata, such as name, path, size, content, and other details,for files within a specified directory. The table also supports filtering by a specific path.The virtual table exposes the following columns:- `name`: `TEXT` - The name of the file.- `path`: `TEXT` - The full path of the file.- `last_modified`: `TEXT` - The last modified timestamp of the file in ISO 8601 format.- `content`: `BLOB` - The binary content of the file (optional).- `size`: `INTEGER` - The size of the file in bytes.- `content_type`: `TEXT` - The MIME type of the file (e.g., `text/plain`, `image/jpeg`).- `digest`: `TEXT` - The MD5 hash of the file content (optional).- `arg_path`: `HIDDEN TEXT` - The base path used for filtering (required for queries). | [{"name":"bucket","data_type":"","description":"`String` (optional) - The bucket name to get files from or set the env variable `S3_BUCKET`."},{"name":"endpoint","data_type":"","description":"`String` (optional) - The endpoint of the S3 bucket or set the env variable `S3_ENDPOINT`."},{"name":"region","data_type":"","description":"`String` (optional) - The region the bucket is located in or `S3_REGION`."},{"name":"access_key_id","data_type":"","description":"`String` (optional) - Access Key ID of the user or `AWS_ACCESS_KEY_ID`."},{"name":"secret_access_key","data_type":"","description":"`String` (optional) - or set the `AWS_SECRET_ACCESS_KEY` varibale"}] | `A table` - | `1.5.4` |
| surveilr_extension_docs | A virtual table that provides details about surveilr SQlite Functions.It reads extension details from the binary and returns them in a tabular format.- `name`: `TEXT` - The name of the function.- `description`: `TEXT` - A description of the function.- `parameters`: `JSON` - A JSON string detailing the function's parameters.- `return_type`: `TEXT` - The return type of the function.- `version`: `TEXT` - The version in which the function was introduced. | [] | 1.5.4 |
(Page 1 of 1)