@terascope/elasticsearch-api 4.12.3 → 4.13.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,70 @@
1
+ import { DataEntity, Logger } from '@terascope/utils';
2
+ import { Client as OpenClient } from '@terascope/opensearch-client';
3
+ import { ClientParams, ClientResponse } from '@terascope/types';
4
+ export interface Config {
5
+ index?: string;
6
+ full_response?: boolean;
7
+ connection?: string;
8
+ _dead_letter_action?: string;
9
+ }
10
+ /**
11
+ * This is used for improved bulk sending function
12
+ */
13
+ export interface BulkRecord {
14
+ action: AnyBulkAction;
15
+ data?: Record<string, any> | DataEntity;
16
+ }
17
+ /**
18
+ * This is used for improved bulk sending function
19
+ */
20
+ export interface AnyBulkAction {
21
+ update?: Partial<BulkActionMetadata>;
22
+ index?: Partial<BulkActionMetadata>;
23
+ create?: Partial<BulkActionMetadata>;
24
+ delete?: Partial<BulkActionMetadata>;
25
+ }
26
+ /**
27
+ * This is used for improved bulk sending function
28
+ */
29
+ export interface BulkActionMetadata {
30
+ _index: string;
31
+ _type: string;
32
+ _id: string | number;
33
+ retry_on_conflict?: number;
34
+ }
35
+ export default function elasticsearchApi(client: OpenClient, logger: Logger, _opConfig?: Config | undefined): {
36
+ search: (query: ClientParams.SearchParams) => Promise<ClientResponse.SearchResponse | any[]>;
37
+ count: (query: ClientParams.CountParams) => Promise<number>;
38
+ get: (query: ClientParams.GetParams, fullResponse?: boolean) => Promise<any>;
39
+ mget: (query: ClientParams.MGetParams, fullResponse?: boolean) => Promise<any>;
40
+ index: (query: ClientParams.IndexParams) => Promise<unknown>;
41
+ indexWithId: (query: ClientParams.IndexParams) => Promise<unknown>;
42
+ isAvailable: (index: string, recordType?: string) => Promise<unknown>;
43
+ create: (query: ClientParams.CreateParams) => Promise<unknown>;
44
+ update: (query: ClientParams.UpdateParams) => Promise<any>;
45
+ remove: (query: ClientParams.DeleteParams) => Promise<ClientResponse.DeleteResponse>;
46
+ version: () => Promise<boolean | void>;
47
+ putTemplate: (template: Record<string, any>, name: string) => Promise<any>;
48
+ bulkSend: (data: BulkRecord[] | Record<string, any>[]) => Promise<number>;
49
+ nodeInfo: () => Promise<ClientResponse.NodesInfoResponse>;
50
+ nodeStats: () => Promise<ClientResponse.NodesStatsResponse>;
51
+ buildQuery: (opConfig: Record<string, any>, msg: Record<string, any>) => ClientParams.SearchParams;
52
+ indexExists: (query: ClientParams.IndicesExistsParams) => Promise<boolean>;
53
+ indexCreate: (query: ClientParams.IndicesCreateParams) => Promise<any>;
54
+ indexRefresh: (query: ClientParams.IndicesRefreshParams) => Promise<any>;
55
+ indexRecovery: (query: ClientParams.IndicesRefreshParams) => Promise<any>;
56
+ indexSetup: (clusterName: string, newIndex: string, migrantIndexName: string, mapping: Record<string, any>, recordType: string, clientName: string, _time?: number) => Promise<boolean>;
57
+ verifyClient: () => boolean;
58
+ validateGeoParameters: (opConfig: Record<string, any>) => void;
59
+ getClientMetadata: () => import("@terascope/types").ClientMetadata;
60
+ isElasticsearch6: () => boolean;
61
+ isElasticsearch8: () => boolean;
62
+ index_exists: (query: ClientParams.IndicesExistsParams) => Promise<boolean>;
63
+ index_create: (query: ClientParams.IndicesCreateParams) => Promise<any>;
64
+ index_refresh: (query: ClientParams.IndicesRefreshParams) => Promise<any>;
65
+ index_recovery: (query: ClientParams.IndicesRefreshParams) => Promise<any>;
66
+ getESVersion: () => number;
67
+ isErrorRetryable: (err: Error) => boolean;
68
+ };
69
+ export type Client = ReturnType<typeof elasticsearchApi>;
70
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAKsB,UAAU,EACH,MAAM,EACzC,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EACsC,YAAY,EACrD,cAAc,EACjB,MAAM,kBAAkB,CAAC;AAQ1B,MAAM,WAAW,MAAM;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED;;MAEM;AACN,MAAM,WAAW,UAAU;IACvB,MAAM,EAAE,aAAa,CAAC;IAEtB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,UAAU,CAAC;CAC3C;AAED;;MAEM;AACN,MAAM,WAAW,aAAa;IAC1B,MAAM,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACrC,KAAK,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACpC,MAAM,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACrC,MAAM,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;CACxC;AAED;;MAEM;AACN,MAAM,WAAW,kBAAkB;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAID,MAAM,CAAC,OAAO,UAAU,gBAAgB,CACpC,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,MAAM,EACd,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS;oBAwDnB,YAAY,CAAC,YAAY,KACjC,OAAO,CAAC,cAAc,CAAC,cAAc,GAAG,GAAG,EAAE,CAAC;mBArCrB,YAAY,CAAC,WAAW;iBAgHxB,YAAY,CAAC,SAAS,6BAAyB,OAAO,CAAC,GAAG,CAAC;kBAT5D,YAAY,CAAC,UAAU;mBAkBpB,YAAY,CAAC,WAAW;yBAIpB,YAAY,CAAC,WAAW;yBAmuBxB,MAAM,eAAe,MAAM;oBA/tBhC,YAAY,CAAC,YAAY;oBAIzB,YAAY,CAAC,YAAY,KAAG,OAAO,CAAC,GAAG,CAAC;oBAQ1D,YAAY,CAAC,YAAY,KACjC,OAAO,CAAC,cAAc,CAAC,cAAc,CAAC;;4BAwGJ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,QAAQ,MAAM,KAAG,OAAO,CAAC,GAAG,CAAC;qBAiKvD,UAAU,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE;;;2BAgOpD,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,OACxB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KACzB,YAAY,CAAC,YAAY;yBAteM,YAAY,CAAC,mBAAmB,KAAG,OAAO,CAAC,OAAO,CAAC;yBAInD,YAAY,CAAC,mBAAmB,KAAG,OAAO,CAAC,GAAG,CAAC;0BAK9C,YAAY,CAAC,oBAAoB,KAAG,OAAO,CAAC,GAAG,CAAC;2BAI/C,YAAY,CAAC,oBAAoB,KAAG,OAAO,CAAC,GAAG,CAAC;8BAyiCnE,MAAM,YACT,MAAM,oBACE,MAAM,WACf,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,cAChB,MAAM,cACN,MAAM,UACV,MAAM,KACf,OAAO,CAAC,OAAO,CAAC;;sCAlyBsB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;;;;0BA3R1B,YAAY,CAAC,mBAAmB,KAAG,OAAO,CAAC,OAAO,CAAC;0BAInD,YAAY,CAAC,mBAAmB,KAAG,OAAO,CAAC,GAAG,CAAC;2BAK9C,YAAY,CAAC,oBAAoB,KAAG,OAAO,CAAC,GAAG,CAAC;4BAI/C,YAAY,CAAC,oBAAoB,KAAG,OAAO,CAAC,GAAG,CAAC;;4BAqpBrD,KAAK;EA4gBvC;AAED,MAAM,MAAM,MAAM,GAAG,UAAU,CAAC,OAAO,gBAAgB,CAAC,CAAC"}