Sponsor
DSL References
DSL stands for Domain Specific Language. In Flow, the DSL is a set of small functions that wrap object construction so pipelines read top-to-bottom. See the examples for usage in context.
EXTRACTOR
from_es
/**
* Extractor will automatically try to iterate over whole index using one of the two iteration methods:.
*
* - from/size
* - search_after
*
* Search after is selected when you provide define sort parameters in query, otherwise it will fallback to from/size.
*
* @param array{
* hosts?: array<string>,
* connectionParams?: array<mixed>,
* retries?: int,
* sniffOnStart?: bool,
* sslCert?: array<string>,
* sslKey?: array<string>,
* sslVerification?: bool|string,
* elasticMetaHeader?: bool,
* includePortInHostHeader?: bool
* } $config
* @param array<mixed> $parameters - https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html
* @param ?array<mixed> $pit_params - 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
*/
from_es(array $config, array $parameters, ?array $pit_params) : ElasticsearchExtractorHELPER
entry_id_factory(string $entry_name) : IdFactory/**
* Transforms elasticsearch results into clear Flow Rows using ['hits']['hits'][x]['_source'].
*
* @return HitsIntoRowsTransformer
*/
es_hits_to_rows(DocumentDataSource $source) : HitsIntoRowsTransformerhash_id_factory(string $entry_names) : IdFactoryLOADER
/**
* https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html.
*
* In order to control the size of the single request, use DataFrame::chunkSize() method just before calling DataFrame::load().
*
* @param array{
* hosts?: array<string>,
* connectionParams?: array<mixed>,
* retries?: int,
* sniffOnStart?: bool,
* sslCert?: array<string>,
* sslKey?: array<string>,
* sslVerification?: bool|string,
* elasticMetaHeader?: bool,
* includePortInHostHeader?: bool
* } $config
* @param string $index
* @param IdFactory $id_factory
* @param array<mixed> $parameters - https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html - @deprecated use withParameters method instead
*/
to_es_bulk_index(array $config, string $index, IdFactory $id_factory, array $parameters) : ElasticsearchLoader/**
* https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html.
*
* In order to control the size of the single request, use DataFrame::chunkSize() method just before calling DataFrame::load().
*
* @param array{
* hosts?: array<string>,
* connectionParams?: array<mixed>,
* retries?: int,
* sniffOnStart?: bool,
* sslCert?: array<string>,
* sslKey?: array<string>,
* sslVerification?: bool|string,
* elasticMetaHeader?: bool,
* includePortInHostHeader?: bool
* } $config
* @param string $index
* @param IdFactory $id_factory
* @param array<mixed> $parameters - https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html - @deprecated use withParameters method instead
*/
to_es_bulk_update(array $config, string $index, IdFactory $id_factory, array $parameters) : ElasticsearchLoader
