functions.php
Functions
to_es_bulk_index()
https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html.
to_es_bulk_index(array{hosts?: string[], connectionParams?: array, retries?: int, sniffOnStart?: bool, sslCert?: string[], sslKey?: string[], sslVerification?: bool|string, elasticMetaHeader?: bool, includePortInHostHeader?: bool} $config, string $index, IdFactory $id_factory[, array<string|int, mixed> $parameters = [] ]) : ElasticsearchLoader
In order to control the size of the single request, use DataFrame::chunkSize() method just before calling DataFrame::load().
Parameters
- $config : array{hosts?: string[], connectionParams?: array, retries?: int, sniffOnStart?: bool, sslCert?: string[], sslKey?: string[], sslVerification?: bool|string, elasticMetaHeader?: bool, includePortInHostHeader?: bool}
- $index : string
- $id_factory : IdFactory
- $parameters : array<string|int, mixed> = []
-
- https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html - @deprecated use withParameters method instead
Return values
ElasticsearchLoaderentry_id_factory()
entry_id_factory(string $entry_name) : IdFactory
Parameters
- $entry_name : string
Return values
IdFactoryhash_id_factory()
hash_id_factory(string ...$entry_names) : IdFactory
Parameters
- $entry_names : string
Return values
IdFactoryto_es_bulk_update()
https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html.
to_es_bulk_update(array{hosts?: string[], connectionParams?: array, retries?: int, sniffOnStart?: bool, sslCert?: string[], sslKey?: string[], sslVerification?: bool|string, elasticMetaHeader?: bool, includePortInHostHeader?: bool} $config, string $index, IdFactory $id_factory[, array<string|int, mixed> $parameters = [] ]) : ElasticsearchLoader
In order to control the size of the single request, use DataFrame::chunkSize() method just before calling DataFrame::load().
Parameters
- $config : array{hosts?: string[], connectionParams?: array, retries?: int, sniffOnStart?: bool, sslCert?: string[], sslKey?: string[], sslVerification?: bool|string, elasticMetaHeader?: bool, includePortInHostHeader?: bool}
- $index : string
- $id_factory : IdFactory
- $parameters : array<string|int, mixed> = []
-
- https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html - @deprecated use withParameters method instead
Return values
ElasticsearchLoaderes_hits_to_rows()
Transforms elasticsearch results into clear Flow Rows using ['hits']['hits'][x]['_source'].
es_hits_to_rows([DocumentDataSource $source = DocumentDataSource::source ]) : HitsIntoRowsTransformer
Parameters
- $source : DocumentDataSource = DocumentDataSource::source
Return values
HitsIntoRowsTransformerfrom_es()
Extractor will automatically try to iterate over whole index using one of the two iteration methods:.
from_es(array{hosts?: string[], connectionParams?: array, retries?: int, sniffOnStart?: bool, sslCert?: string[], sslKey?: string[], sslVerification?: bool|string, elasticMetaHeader?: bool, includePortInHostHeader?: bool} $config, array<string|int, mixed> $parameters[, array<string|int, mixed>|null $pit_params = null ]) : ElasticsearchExtractor
- from/size
- search_after
Search after is selected when you provide define sort parameters in query, otherwise it will fallback to from/size.
Parameters
- $config : array{hosts?: string[], connectionParams?: array, retries?: int, sniffOnStart?: bool, sslCert?: string[], sslKey?: string[], sslVerification?: bool|string, elasticMetaHeader?: bool, includePortInHostHeader?: bool}
- $parameters : array<string|int, mixed>
-
- https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html
- $pit_params : array<string|int, mixed>|null = null
-
- when used extractor will create point in time to stabilize search results. Point in time is automatically closed when last element is extracted. https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time-api.html - @deprecated use withPointInTime method instead