@lowdefy/connection-elasticsearch 0.0.0-experimental-20251010122007 → 0.0.0-experimental-20251015143743

package/dist/connections/Elasticsearch/ElasticsearchUpdate/documentation.md

@@ -1,258 +0,0 @@
-<TITLE>
-ElasticsearchUpdate
-</TITLE>
-
-<DESCRIPTION>
-
-The `ElasticsearchUpdate` request updates a document using a script or partial document.
-
-### Properties
-
-- `id: string|number` Unique identifier for the document to be updated.
-- `body: object` The Elasticsearch request body contains either a [script](https://www.elastic.co/guide/en/elasticsearch/reference/7.x/modules-scripting-using.html) or a `doc` property with fields to update.
-- `if_seq_no: number` Only perform the operation if the document has this sequence number. See [Optimistic concurrency control](https://www.elastic.co/guide/en/elasticsearch/reference/7.x/docs-index_.html#optimistic-concurrency-control-index).
-- `if_primary_term: number` Only perform the operation if the document has this primary term. See [Optimistic concurrency control](https://www.elastic.co/guide/en/elasticsearch/reference/7.x/docs-index_.html#optimistic-concurrency-control-index).
-- `require_alias: boolean` If `true`, the destination must be an [index alias](https://www.elastic.co/guide/en/elasticsearch/reference/7.x/alias.html). Defaults to `false`.
-- `refresh: string|boolean` If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes. Valid values: `true`, `false`, `wait_for`. Default: `false`.
-- `retry_on_conflict: boolean` Specify how many times should the operation be retried when a conflict occurs. Default: `0`.
-- `routing: string` Custom value used to route operations to a specific shard.
-- `_source: string[]|boolean` Set to `false` to disable source retrieval (default: `true`). You can also specify a comma-separated list of the fields you want to retrieve.
-- `_source_excludes: string[]` Specify the source fields you want to exclude.
-- `_source_includes: string[]` Specify the source fields you want to include.
-- `timeout: string` Period the request waits for the following operations:
-    - [Dynamic mapping](https://www.elastic.co/guide/en/elasticsearch/reference/7.x/dynamic-mapping.html) updates
-    - [Waiting for active shards](https://www.elastic.co/guide/en/elasticsearch/reference/7.x/docs-index_.html#index-wait-for-active-shards)
-  Defaults to `1m` (one minute). This guarantees Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur.
-- `wait_for_active_shards: string` The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). Default: `1`, the primary shard.
-  See [Active Shards](https://www.elastic.co/guide/en/elasticsearch/reference/7.x/docs-index_.html#index-wait-for-active-shards).
-
-</DESCRIPTION>
-
-<CONNECTION>
-Elasticsearch
-</CONNECTION>
-
-<SCHEMA>
-
-```js
-export default {
-  $schema: 'http://json-schema.org/draft-07/schema#',
-  title: 'Lowdefy Request Schema - ElasticsearchUpdate',
-  type: 'object',
-  description: 'Updates a document using the specified script.',
-  required: ['id', 'body'],
-  properties: {
-    id: {
-      anyOf: [
-        {
-          type: 'string',
-        },
-        {
-          type: 'number',
-        },
-      ],
-      description: 'Unique identifier for the document to be updated.',
-    },
-    index: {
-      type: 'string',
-      description:
-        "Name of the target index. By default, the index is created automatically if it doesn't exist. For more information, see Automatically create data streams and indices.",
-    },
-    if_seq_no: {
-      type: 'integer',
-      description:
-        'Only perform the operation if the document has this sequence number. See Optimistic concurrency control.',
-    },
-    if_primary_term: {
-      type: 'integer',
-      description:
-        'Only perform the operation if the document has this primary term. See Optimistic concurrency control.',
-    },
-    require_alias: {
-      type: 'boolean',
-      description: 'If true, the destination must be an index alias. Defaults to false.',
-      default: false,
-    },
-    refresh: {
-      anyOf: [
-        {
-          type: 'string',
-        },
-        {
-          type: 'boolean',
-        },
-      ],
-      description:
-        'If true, Elasticsearch refreshes the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false do nothing with refreshes. Valid values: true, false, wait_for. Default: false.',
-      enum: ['true', 'false', true, false, 'wait_for'],
-      default: false,
-    },
-    retry_on_conflict: {
-      type: 'integer',
-      description:
-        'Specify how many times should the operation be retried when a conflict occurs. Default: 0.',
-      default: 0,
-    },
-    routing: {
-      description: 'Custom value used to route operations to a specific shard.',
-      type: 'string',
-    },
-    _source: {
-      anyOf: [
-        {
-          type: 'boolean',
-        },
-        {
-          type: 'array',
-        },
-      ],
-      items: {
-        type: 'string',
-      },
-      description:
-        'Set to false to disable source retrieval (default: true). You can also specify a comma-separated list of the fields you want to retrieve.',
-      default: true,
-    },
-    _source_excludes: {
-      type: 'array',
-      items: {
-        type: 'string',
-      },
-      description: 'Specify the source fields you want to exclude.',
-    },
-    _source_includes: {
-      type: 'array',
-      items: {
-        type: 'string',
-      },
-      description: 'Specify the source fields you want to include.',
-    },
-    timeout: {
-      type: 'string',
-      description:
-        'Period to wait for the following operations:\n\nDynamic mapping updates\nWaiting for active shards\nDefaults to 1m (one minute). This guarantees Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur.',
-      default: '1m',
-    },
-    wait_for_active_shards: {
-      type: 'string',
-      description:
-        'The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). Default: 1, the primary shard.',
-      default: '1',
-    },
-    body: {
-      description: 'The request definition requires either script or partial doc.',
-      anyOf: [
-        {
-          required: ['doc'],
-        },
-        {
-          required: ['script'],
-        },
-      ],
-      properties: {
-        doc: {
-          additionalProperties: true,
-          description: 'Partial document to update',
-        },
-        script: {
-          $ref: '#/definitions/Script',
-        },
-      },
-      errorMessage: {
-        anyOf:
-          'ElasticsearchUpdate request should have required property "body.doc" or "body.script".',
-      },
-    },
-  },
-  definitions: {
-    Script: {
-      description: 'An Elasticsearch script.',
-      additionalProperties: false,
-      anyOf: [
-        {
-          required: ['source'],
-        },
-        {
-          required: ['id'],
-        },
-      ],
-      properties: {
-        lang: {
-          type: 'string',
-          enum: ['painless', 'expression', 'mustache', 'java'],
-          description: 'Specifies the language the script is written in. Defaults to painless.',
-          default: 'painless',
-        },
-        source: {
-          description: 'The script itself, which you specify as source for an inline script.',
-          type: 'string',
-        },
-        id: {
-          description:
-            'The script itself, which you specify as id for a stored script. Use the stored script APIs to create and manage stored scripts.',
-          type: 'string',
-        },
-        params: {
-          description:
-            'Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.',
-          type: 'object',
-        },
-      },
-      errorMessage: {
-        anyOf:
-          'ElasticsearchUpdate request should have required property "body.script.source" or "body.script.id".',
-      },
-    },
-  },
-  errorMessage: {
-    type: 'ElasticsearchUpdate request properties should be an object.',
-    required: {
-      id: 'ElasticsearchUpdate request should have required property "id".',
-      body: 'ElasticsearchUpdate request should have required property "body".',
-    },
-  },
-};
-```
-
-</SCHEMA>
-
-<EXAMPLES>
-
-### Update a document
-
-```yaml
-requests:
-  - id: update
-    type:  ElasticsearchUpdate
-    payload:
-      id:
-        _state: _id
-      name:
-        _state: name
-    properties:
-      id:
-        _payload: id
-      body:
-        doc:
-          _payload: name
-```
-
-### Increase the like counter using a script
-
-```yaml
-requests:
-  - id: increase_like_counter
-    type:  ElasticsearchUpdate
-    payload:
-      id:
-        _state: _id
-    properties:
-      id:
-        _payload: id
-      body:
-        script:
-          source: |
-            ctx._source.likes++
-```
-
-</EXAMPLES>

package/dist/connections/Elasticsearch/ElasticsearchUpdateByQuery/documentation.md

@@ -1,296 +0,0 @@
-<TITLE>
-ElasticsearchUpdateByQuery
-</TITLE>
-
-<DESCRIPTION>
-
-The `ElasticsearchUpdateByQuery` request updates documents that match the specified query. If no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.
-
-### Properties
-
-- `body: object` The Elasticsearch query body, expressed in the [JSON Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html).
-  - `query: object`: The Elasticsearch query.
-  - `script: object` A [script](https://www.elastic.co/guide/en/elasticsearch/reference/7.x/modules-scripting-using.html) to update documents.
-- `_source: string|string[]|boolean`: True or false to return the `_source` field or not, or a list of fields to return.
-- `_source_excludes: string|string[]`: A list of fields to exclude from the returned `_source` field.
-- `_source_includes: string|string[]`: A list of fields to extract and return from the `_source` field.
-- `allow_no_indices: boolean`: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified).
-- `max_docs: number` Maximum number of documents to process. Defaults to all documents.
-- `refresh: string|boolean` If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes. Valid values: `true`, `false`, `wait_for`. Default: `false`.
-- `requests_per_second: number` The throttle for this request in sub-requests per second. Defaults to -1 (no throttle).
-- `analyzer: string`: The analyzer to use for the query string
-- `default_operator: string`: The default operator for query string query (AND or OR).
-- `df: string`: The field to use as default where no field prefix is given in the query string.
-- `from: number`: Starting offset.
-- `size: number`: Number of hits to return.
-- `index: string|string[]`: A comma-separated list of index names to search; use _all or empty string to perform the operation on all indices.
-- `lenient: boolean`: Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.
-- `scroll: string`: Specify how long a consistent view of the index should be maintained for scrolled search.
-- `sort: string|string[]`: A comma-separated list of <field>:<direction> pairs.
-
-The request accepts many more advanced configuration options. They will be passed to the Elasticsearch client verbatim, so check out the [available options](https://www.elastic.co/guide/en/elasticsearch/reference/7.x/docs-update-by-query.html#docs-update-by-query-api-query-params) provided by Elastic.
-
-</DESCRIPTION>
-
-<CONNECTION>
-Elasticsearch
-</CONNECTION>
-
-<SCHEMA>
-
-```js
-export default {
-  $schema: 'http://json-schema.org/draft-07/schema#',
-  title: 'Lowdefy Request Schema - ElasticsearchUpdateByQuery',
-  type: 'object',
-  description:
-    'Updates documents that match the specified query. If no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.',
-  properties: {
-    index: {
-      type: 'string',
-      description: 'The name of the index.',
-    },
-    allow_no_indices: {
-      type: 'boolean',
-      description:
-        'If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.',
-      default: true,
-    },
-    analyzer: {
-      description: 'The analyzer to use for the query string.',
-      type: 'string',
-    },
-    analyze_wildcard: {
-      description: 'Specify whether wildcard and prefix queries should be analyzed.',
-      type: 'boolean',
-      default: false,
-    },
-    conflicts: {
-      type: 'string',
-      enum: ['abort', 'proceed'],
-      description:
-        'What to do if update by query hits version conflicts: abort or proceed. Defaults to abort.',
-      default: 'abort',
-    },
-    default_operator: {
-      description: 'The default operator for query string query (AND or OR).',
-      enum: ['AND', 'OR'],
-      type: 'string',
-      default: 'OR',
-    },
-    df: {
-      description:
-        'The field to use as default where no field prefix is given in the query string.',
-      type: 'string',
-    },
-    expand_wildcards: {
-      description:
-        'Whether to expand wildcard expression to concrete indices that are open, closed or both.',
-      enum: ['all', 'closed', 'hidden', 'none', 'open'],
-      type: 'string',
-      default: 'open',
-    },
-    from: {
-      description: 'Starting offset.',
-      type: 'number',
-      default: 0,
-    },
-    ignore_unavailable: {
-      description:
-        'Whether specified concrete indices should be ignored when unavailable (missing or closed)',
-      type: 'boolean',
-    },
-    lenient: {
-      description:
-        'Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.',
-      type: 'boolean',
-    },
-    max_docs: {
-      type: 'integer',
-      description: 'Maximum number of documents to process. Defaults to all documents.',
-    },
-    pipeline: {
-      type: 'string',
-      description: 'ID of the pipeline to use to preprocess incoming documents.',
-    },
-    preference: {
-      description: 'Specify the node or shard the operation should be performed on.',
-      type: 'string',
-      default: 'random',
-    },
-    pretty: {
-      description: 'Pretty format the returned JSON response.',
-      type: 'boolean',
-    },
-    q: {
-      description: 'Query in the Lucene query string syntax.',
-      type: 'string',
-    },
-    request_cache: {
-      description:
-        'Specify if request cache should be used for this request or not, defaults to index level setting.',
-      type: 'boolean',
-    },
-    refresh: {
-      anyOf: [
-        {
-          type: 'string',
-        },
-        {
-          type: 'boolean',
-        },
-      ],
-      description:
-        'If true, Elasticsearch refreshes all shards involved in the delete by query after the request completes. Defaults to false.',
-      enum: ['true', 'false', true, false, 'wait_for'],
-      default: false,
-    },
-    requests_per_second: {
-      type: 'integer',
-      description:
-        'The throttle for this request in sub-requests per second. Defaults to -1 (no throttle).',
-      default: -1,
-    },
-    routing: {
-      type: 'string',
-      description: 'Custom value used to route operations to a specific shard.',
-    },
-    scroll: {
-      type: 'string',
-      description: 'Period to retain the search context for scrolling. See Scroll search results.',
-    },
-    scroll_size: {
-      type: 'integer',
-      description: 'Size on the scroll request powering the update by query. Defaults to 100.',
-      default: 100,
-    },
-    search_type: {
-      description: 'Search operation type.',
-      enum: ['dfs_query_then_fetch', 'query_then_fetch'],
-      type: 'string',
-    },
-    search_timeout: {
-      type: 'string',
-      description: 'Explicit timeout for each search request. Defaults to no timeout.',
-    },
-    slices: {
-      type: 'integer',
-      description:
-        "The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks.",
-    },
-    sort: {
-      description: 'A comma-separated list of <field>:<direction> pairs.',
-      examples: ['name:asc', ['rating:asc', 'created_at:desc']],
-      anyOf: [
-        {
-          items: {
-            type: 'string',
-          },
-          type: 'array',
-        },
-        {
-          type: 'string',
-        },
-      ],
-    },
-    _source: {
-      anyOf: [
-        {
-          type: 'boolean',
-        },
-        {
-          type: 'array',
-        },
-      ],
-      items: {
-        type: 'string',
-      },
-      description:
-        'True or false to return the _source field or not, or a list of fields to return.',
-    },
-    _source_excludes: {
-      type: 'array',
-      items: {
-        type: 'string',
-      },
-      description:
-        'A comma-separated list of source fields to exclude from the response.\n\nYou can also use this parameter to exclude fields from the subset specified in _source_includes query parameter.\n\nIf the _source parameter is false, this parameter is ignored.',
-    },
-    _source_includes: {
-      type: 'array',
-      items: {
-        type: 'string',
-      },
-      description:
-        'A comma-separated list of source fields to include in the response.\n\nIf this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the _source_excludes query parameter.\n\nIf the _source parameter is false, this parameter is ignored.',
-    },
-    stats: {
-      description: 'Specific tag of the request for logging and statistical purposes',
-      anyOf: [
-        {
-          items: {
-            type: 'string',
-          },
-          type: 'array',
-        },
-        {
-          type: 'string',
-        },
-      ],
-    },
-    terminate_after: {
-      description:
-        'The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early. Elasticsearch collects documents before sorting.\nUse with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.',
-      type: 'number',
-    },
-    timeout: {
-      type: 'string',
-      description:
-        'Period each deletion request waits for active shards. Defaults to 1m (one minute).',
-      default: '1m',
-    },
-    version: {
-      description:
-        'Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.',
-      type: 'integer',
-    },
-    wait_for_active_shards: {
-      type: 'string',
-      description:
-        'The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). Default: 1, the primary shard.',
-      default: '1',
-    },
-    wait_for_completion: {
-      type: 'boolean',
-      description:
-        'Should the request should block until the update by query operation is complete. Default: true',
-      default: true,
-    },
-  },
-  errorMessage: {
-    type: 'ElasticsearchDelete request properties should be an object.',
-  },
-};
-```
-
-</SCHEMA>
-
-<EXAMPLES>
-
-### Update all red cars
-
-```yaml
-requests:
-  - id: update_red_cars
-    type:  ElasticsearchUpdateByQuery
-    properties:
-      body:
-        query:
-          term:
-            color:
-              value: red
-        script:
-          source: 'ctx._source.out_of_stock=true'
-```
-
-</EXAMPLES>