Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Index pattern class - remove unused methods #78538

Merged
merged 4 commits into from
Sep 28, 2020
Merged

Index pattern class - remove unused methods #78538

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
55f8dc7
remove unused methods
mattkime Sep 25, 2020
dcf2045
fix tests
mattkime Sep 25, 2020
83bbf62
Merge branch 'master' into index_pattern_remove_unused_methods
mattkime Sep 26, 2020
8f21640
Merge branch 'master' into index_pattern_remove_unused_methods
elasticmachine Sep 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .../data/public/kibana-plugin-plugins-data-public.indexpattern.addscriptedfield.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Add scripted field to field list
<b>Signature:</b>

```typescript
addScriptedField(name: string, script: string, fieldType?: string, lang?: string): Promise<void>;
addScriptedField(name: string, script: string, fieldType?: string): Promise<void>;
```

## Parameters
Expand All @@ -19,7 +19,6 @@ addScriptedField(name: string, script: string, fieldType?: string, lang?: string
| name | <code>string</code> | |
| script | <code>string</code> | |
| fieldType | <code>string</code> | |
| lang | <code>string</code> | |

<b>Returns:</b>

Expand Down
15 changes: 0 additions & 15 deletions ...ta/public/kibana-plugin-plugins-data-public.indexpattern.istimebasedwildcard.md
View file
Open in desktop

This file was deleted.

3 changes: 1 addition & 2 deletions ...velopment/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ export declare class IndexPattern implements IIndexPattern

| Method | Modifiers | Description |
| --- | --- | --- |
| [addScriptedField(name, script, fieldType, lang)](./kibana-plugin-plugins-data-public.indexpattern.addscriptedfield.md) | | Add scripted field to field list |
| [addScriptedField(name, script, fieldType)](./kibana-plugin-plugins-data-public.indexpattern.addscriptedfield.md) | | Add scripted field to field list |
| [getAggregationRestrictions()](./kibana-plugin-plugins-data-public.indexpattern.getaggregationrestrictions.md) | | |
| [getAsSavedObjectBody()](./kibana-plugin-plugins-data-public.indexpattern.getassavedobjectbody.md) | | Returns index pattern as saved object body for saving |
| [getComputedFields()](./kibana-plugin-plugins-data-public.indexpattern.getcomputedfields.md) | | |
Expand All @@ -52,7 +52,6 @@ export declare class IndexPattern implements IIndexPattern
| [getSourceFiltering()](./kibana-plugin-plugins-data-public.indexpattern.getsourcefiltering.md) | | Get the source filtering configuration for that index. |
| [getTimeField()](./kibana-plugin-plugins-data-public.indexpattern.gettimefield.md) | | |
| [isTimeBased()](./kibana-plugin-plugins-data-public.indexpattern.istimebased.md) | | |
| [isTimeBasedWildcard()](./kibana-plugin-plugins-data-public.indexpattern.istimebasedwildcard.md) | | |
| [isTimeNanosBased()](./kibana-plugin-plugins-data-public.indexpattern.istimenanosbased.md) | | |
| [popularizeField(fieldName, unit)](./kibana-plugin-plugins-data-public.indexpattern.popularizefield.md) | | |
| [removeScriptedField(fieldName)](./kibana-plugin-plugins-data-public.indexpattern.removescriptedfield.md) | | Remove scripted field from field list |
Expand Down
3 changes: 1 addition & 2 deletions .../data/server/kibana-plugin-plugins-data-server.indexpattern.addscriptedfield.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Add scripted field to field list
<b>Signature:</b>

```typescript
addScriptedField(name: string, script: string, fieldType?: string, lang?: string): Promise<void>;
addScriptedField(name: string, script: string, fieldType?: string): Promise<void>;
```

## Parameters
Expand All @@ -19,7 +19,6 @@ addScriptedField(name: string, script: string, fieldType?: string, lang?: string
| name | <code>string</code> | |
| script | <code>string</code> | |
| fieldType | <code>string</code> | |
| lang | <code>string</code> | |

<b>Returns:</b>

Expand Down
15 changes: 0 additions & 15 deletions ...ta/server/kibana-plugin-plugins-data-server.indexpattern.istimebasedwildcard.md
View file
Open in desktop

This file was deleted.

3 changes: 1 addition & 2 deletions ...velopment/plugins/data/server/kibana-plugin-plugins-data-server.indexpattern.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ export declare class IndexPattern implements IIndexPattern

| Method | Modifiers | Description |
| --- | --- | --- |
| [addScriptedField(name, script, fieldType, lang)](./kibana-plugin-plugins-data-server.indexpattern.addscriptedfield.md) | | Add scripted field to field list |
| [addScriptedField(name, script, fieldType)](./kibana-plugin-plugins-data-server.indexpattern.addscriptedfield.md) | | Add scripted field to field list |
| [getAggregationRestrictions()](./kibana-plugin-plugins-data-server.indexpattern.getaggregationrestrictions.md) | | |
| [getAsSavedObjectBody()](./kibana-plugin-plugins-data-server.indexpattern.getassavedobjectbody.md) | | Returns index pattern as saved object body for saving |
| [getComputedFields()](./kibana-plugin-plugins-data-server.indexpattern.getcomputedfields.md) | | |
Expand All @@ -52,7 +52,6 @@ export declare class IndexPattern implements IIndexPattern
| [getSourceFiltering()](./kibana-plugin-plugins-data-server.indexpattern.getsourcefiltering.md) | | Get the source filtering configuration for that index. |
| [getTimeField()](./kibana-plugin-plugins-data-server.indexpattern.gettimefield.md) | | |
| [isTimeBased()](./kibana-plugin-plugins-data-server.indexpattern.istimebased.md) | | |
| [isTimeBasedWildcard()](./kibana-plugin-plugins-data-server.indexpattern.istimebasedwildcard.md) | | |
| [isTimeNanosBased()](./kibana-plugin-plugins-data-server.indexpattern.istimenanosbased.md) | | |
| [popularizeField(fieldName, unit)](./kibana-plugin-plugins-data-server.indexpattern.popularizefield.md) | | |
| [removeScriptedField(fieldName)](./kibana-plugin-plugins-data-server.indexpattern.removescriptedfield.md) | | Remove scripted field from field list |
Expand Down
5 changes: 2 additions & 3 deletions src/plugins/data/common/index_patterns/index_patterns/index_pattern.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,8 +179,7 @@ describe('IndexPattern', () => {
await indexPattern.addScriptedField(
scriptedField.name,
scriptedField.script,
scriptedField.type,
'lang'
scriptedField.type
);

const scriptedFields = indexPattern.getScriptedFields();
Expand All @@ -206,7 +205,7 @@ describe('IndexPattern', () => {
const scriptedField = last(scriptedFields) as any;
expect.assertions(1);
try {
await indexPattern.addScriptedField(scriptedField.name, "'new script'", 'string', 'lang');
await indexPattern.addScriptedField(scriptedField.name, "'new script'", 'string');
} catch (e) {
expect(e).toBeInstanceOf(DuplicateField);
}
Expand Down
22 changes: 3 additions & 19 deletions src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,12 +234,7 @@ export class IndexPattern implements IIndexPattern {
* @param fieldType
* @param lang
*/
async addScriptedField(
name: string,
script: string,
fieldType: string = 'string',
lang: string = 'painless'
) {
async addScriptedField(name: string, script: string, fieldType: string = 'string') {
const scriptedFields = this.getScriptedFields();
const names = _.map(scriptedFields, 'name');

Expand All @@ -252,7 +247,7 @@ export class IndexPattern implements IIndexPattern {
script,
type: fieldType,
scripted: true,
lang,
lang: 'painless',
aggregatable: true,
searchable: true,
count: 0,
Expand Down Expand Up @@ -322,13 +317,9 @@ export class IndexPattern implements IIndexPattern {
return timeField && timeField.esTypes && timeField.esTypes.indexOf('date_nanos') !== -1;
}

isTimeBasedWildcard(): boolean {
return this.isTimeBased() && this.isWildcard();
}

getTimeField() {
if (!this.timeFieldName || !this.fields || !this.fields.getByName) return undefined;
return this.fields.getByName(this.timeFieldName) || undefined;
return this.fields.getByName(this.timeFieldName);
}

getFieldByName(name: string): IndexPatternField | undefined {
Expand All @@ -340,13 +331,6 @@ export class IndexPattern implements IIndexPattern {
return this.typeMeta?.aggs;
}

/**
* Does this index pattern title include a '*'
*/
private isWildcard() {
return _.includes(this.title, '*');
}

/**
* Returns index pattern as saved object body for saving
*/
Expand Down
4 changes: 1 addition & 3 deletions src/plugins/data/public/public.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1086,7 +1086,7 @@ export type IMetricAggType = MetricAggType;
export class IndexPattern implements IIndexPattern {
// Warning: (ae-forgotten-export) The symbol "IndexPatternDeps" needs to be exported by the entry point index.d.ts
constructor({ spec, savedObjectsClient, fieldFormats, shortDotsEnable, metaFields, }: IndexPatternDeps);
addScriptedField(name: string, script: string, fieldType?: string, lang?: string): Promise<void>;
addScriptedField(name: string, script: string, fieldType?: string): Promise<void>;
// (undocumented)
fieldFormatMap: Record<string, any>;
// (undocumented)
Expand Down Expand Up @@ -1159,8 +1159,6 @@ export class IndexPattern implements IIndexPattern {
// (undocumented)
isTimeBased(): boolean;
// (undocumented)
isTimeBasedWildcard(): boolean;
// (undocumented)
isTimeNanosBased(): boolean;
// (undocumented)
metaFields: string[];
Expand Down
4 changes: 1 addition & 3 deletions src/plugins/data/server/server.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -624,7 +624,7 @@ export type IMetricAggType = MetricAggType;
export class IndexPattern implements IIndexPattern {
// Warning: (ae-forgotten-export) The symbol "IndexPatternDeps" needs to be exported by the entry point index.d.ts
constructor({ spec, savedObjectsClient, fieldFormats, shortDotsEnable, metaFields, }: IndexPatternDeps);
addScriptedField(name: string, script: string, fieldType?: string, lang?: string): Promise<void>;
addScriptedField(name: string, script: string, fieldType?: string): Promise<void>;
// (undocumented)
fieldFormatMap: Record<string, any>;
// Warning: (ae-forgotten-export) The symbol "IIndexPatternFieldList" needs to be exported by the entry point index.d.ts
Expand Down Expand Up @@ -701,8 +701,6 @@ export class IndexPattern implements IIndexPattern {
// (undocumented)
isTimeBased(): boolean;
// (undocumented)
isTimeBasedWildcard(): boolean;
// (undocumented)
isTimeNanosBased(): boolean;
// (undocumented)
metaFields: string[];
Expand Down