view release on metacpan or  search on metacpan

lib/OpenSearch/Client/Core/3_0/Direct.pm  view on Meta::CPAN

Allows to perform multiple index/update/delete operations in a single request.


I<Paths served by this method:>

=over

=item
C<POST /_bulk>

=item
C<POST /{index}/_bulk>

=item
C<PUT /_bulk>

=item
C<PUT /{index}/_bulk>

=back

I<Method added in OpenSearch version 1.0>


    $resp = $client->bulk(
        
        'body'                    =>  $body,      # required
        
         # path parameters
        
        'index'                   =>  $index,     # optional
        
         # Endpoint specific query string parameters
        
        '_source'                 =>  $qval1,     # list
        '_source_excludes'        =>  $qval2,     # list
        '_source_includes'        =>  $qval3,     # list
        'index'                   =>  $qval4,     # string
        'pipeline'                =>  $qval5,     # string
        'refresh'                 =>  $qval6,     # boolean|string
        'require_alias'           =>  $qval7,     # boolean
        'routing'                 =>  $qval8,     # string
        'timeout'                 =>  $qval9,     # string
        'type'                    =>  $qval10,    # string
        'wait_for_active_shards'  =>  $qval11,    # string
        
         # Common API query string parameters
        
        'error_trace'             =>  $qval12,    # boolean
        'filter_path'             =>  $qval13,    # list
        'human'                   =>  $qval14,    # boolean
        'pretty'                  =>  $qval15,    # boolean
        'source'                  =>  $qval16,    # string
    );

L<OpenSearch documentation for bulk|https://opensearch.org/docs/latest/api-reference/document-apis/bulk/>
    
=head2 bulk_stream

Allows to perform multiple index/update/delete operations using request response streaming.


I<Paths served by this method:>

=over

=item
C<POST /_bulk/stream>

=item
C<POST /{index}/_bulk/stream>

=item
C<PUT /_bulk/stream>

=item
C<PUT /{index}/_bulk/stream>

=back

I<Method added in OpenSearch version 2.17>


    $resp = $client->bulk_stream(
        
        'body'                    =>  $body,      # required
        
         # path parameters
        
        'index'                   =>  $index,     # optional
        
         # Endpoint specific query string parameters
        
        '_source'                 =>  $qval1,     # list
        '_source_excludes'        =>  $qval2,     # list
        '_source_includes'        =>  $qval3,     # list
        'batch_interval'          =>  $qval4,     # string
        'batch_size'              =>  $qval5,     # number
        'pipeline'                =>  $qval6,     # string
        'refresh'                 =>  $qval7,     # boolean|string
        'require_alias'           =>  $qval8,     # boolean
        'routing'                 =>  $qval9,     # list
        'timeout'                 =>  $qval10,    # string
        'type'                    =>  $qval11,    # string
        'wait_for_active_shards'  =>  $qval12,    # string
        
         # Common API query string parameters
        
        'error_trace'             =>  $qval13,    # boolean
        'filter_path'             =>  $qval14,    # list
        'human'                   =>  $qval15,    # boolean
        'pretty'                  =>  $qval16,    # boolean
        'source'                  =>  $qval17,    # string
    );

L<OpenSearch documentation for bulk_stream|https://opensearch.org/docs/latest/api-reference/document-apis/bulk-streaming/>
    
=head2 clear_scroll

Explicitly clears the search context for a scroll.


I<Paths served by this method:>

=over

=item
C<DELETE /_search/scroll>

=item
C<DELETE /_search/scroll/{scroll_id}>

=back

I<Method added in OpenSearch version 1.0>


    $resp = $client->clear_scroll(
        
        'body'         =>  $body,      # optional
        
         # path parameters
        
        'scroll_id'    =>  $scroll_id,  # optional
        
         # Common API query string parameters
        
        'error_trace'  =>  $qval1,     # boolean
        'filter_path'  =>  $qval2,     # list
        'human'        =>  $qval3,     # boolean
        'pretty'       =>  $qval4,     # boolean
        'source'       =>  $qval5,     # string
    );

L<OpenSearch documentation for clear_scroll|https://opensearch.org/docs/latest/api-reference/scroll/>
    
=head2 count

Returns number of documents matching a query.


I<Paths served by this method:>

=over

=item
C<GET /_count>

=item
C<GET /{index}/_count>

=item
C<POST /_count>

=item
C<POST /{index}/_count>