The createParserFromTemplate() GraphQL mutation may be used to create a parser from a yaml specification.

For more information on creating a parser, see the Creating a Parser documentation page. You may also want to look at the Parsing Data page for related information.

Syntax

Below is the syntax for the createParserFromTemplate() mutation field:

graphql
createParserFromTemplate(
      input: CreateParserFromTemplateInput!
   ): Parser!

Given Datatypes

For the input CreateParserFromTemplateInput, there are several parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: CreateParserFromTemplateInput

ParameterTypeRequired[a]DefaultDescription
viewNameRepoOrViewNameyes Name of the view of the parser. The datatype is a scalar.
namestringyes Name of the parser.
yamlTemplateYAMLyes The YAML specification of the parser.

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.


Returned Datatypes

The returned datatype Parser has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: Parser

ParameterTypeRequired[a]DefaultDescription
idstringyes The unique identifier of the parser.
namestringyes The name of the parser.
displayNamestringyes The full name of the parser, including package information if part of an application.
isBuiltInbooleanyes True if the parser is one of LogScale's built-in parsers.
sourceCodestringyes The source code of the parser. This field is deprecated and will be replaced with script starting with version 1.142.
languageVersionLanguageVersionyes The language version used by the parser (see LanguageVersion Table).
tagFields[string]yes The fields to use as tags. This field is deprecated and will be replaced with fieldsToTag starting with version 1.142.
yamlTemplateYAMLyes A template that can be used to recreate the parser.
testData[string]yes Saved test data (e.g. log lines) that you can use to test the parser. This field is deprecated and will be replaced with testCases starting with version 1.142.
packagePackageInstallation  The package associated with the parser, if any. See PackageInstallation Table.
descriptionstring  A description of the parser.
assetTypeAssetTypeyes The type of asset (see AssetType Table). This enumerated datatype has been deprecated and will be removed in version 1.136 of LogScale.

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.