The validateQuery() GraphQL query is used to
check that a query compiles. This field is deprecated. Use
analyzeQuery()
, instead.
For more information on saved queries, see the
User Functions (Saved Searches) reference page where saved
queries are discussed. Also, look at the
Searching Data documentation page as it relates to
recent queries and saving queries.
Below is the syntax for the validateQuery()
query field:
validateQuery(
queryString : string!
version : LanguageVersionEnum!
isLive : boolean
arguments : [ QueryArgument! ]
) : QueryValidationResult!
Again, since this field is deprecated, use instead
analyzeQuery()
. Below is an
example, though, of how this query field might be used:
Show:
Raw Mac OS or Linux (curl) Mac OS or Linux (curl) One-line Windows Cmd and curl Windows Powershell and curl Perl Python Node.js
Raw query {
validateQuery( queryString : "host=localhost" ,
version : legacy, isLive : false )
{ isValid, diagnostics{ severity, message, code} }
}
Mac OS or Linux (curl) curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d @- << EOF
{"query" : "query {
validateQuery(queryString:\"host=localhost\",
version: legacy, isLive: false)
{isValid, diagnostics{severity, message, code}}
}"
}
EOF
Mac OS or Linux (curl) One-line curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d @- << EOF
{"query" : "query {
validateQuery(queryString:\"host=localhost\",
version: legacy, isLive: false)
{isValid, diagnostics{severity, message, code}}
}"
}
EOF
Windows Cmd and curl curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
-H "Authorization: Bearer $TOKEN" ^
-H "Content-Type: application/json" ^
-d @'{"query" : "query { ^
validateQuery(queryString:\"host=localhost\", ^
version: legacy, isLive: false) ^
{isValid, diagnostics{severity, message, code}} ^
}" ^
} '
Windows Powershell and curl curl.exe -X POST
-H "Authorization: Bearer $TOKEN "
-H "Content-Type: application/json"
-d '{"query" : "query {
validateQuery(queryString:\"host=localhost\",
version: legacy, isLive: false)
{isValid, diagnostics{severity, message, code}}
}"
}'
"$YOUR_LOGSCALE_URL /graphql"
Perl
use HTTP::Request;
use LWP;
my $INGEST_TOKEN = "TOKEN" ;
my $uri = '$YOUR_LOGSCALE_URL/graphql' ;
my $json = '{"query" : "query {
validateQuery(queryString:\"host=localhost\",
version: legacy, isLive: false)
{isValid, diagnostics{severity, message, code}}
}"
}' ;
my $req = HTTP::Request->new("POST" , $uri );
$req->header("Authorization" => "Bearer $TOKEN" );
$req->header("Content-Type" => "application/json" );
$req->content( $json );
my $lwp = LWP::UserAgent->new;
my $result = $lwp->request( $req );
print $result->{"_content" },"\n" ;
Python
import requests
url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "query {
validateQuery(queryString:\"host=localhost\",
version: legacy, isLive: false)
{isValid, diagnostics{severity, message, code}}
}"
}'''
resp = requests.post(url,
data = mydata,
headers = {
"Authorization" : "Bearer $TOKEN" ,
"Content-Type" : "application/json"
}
)
print (resp.text)
Node.js const https = require ('https' );
const data = JSON .stringify (
{"query" : "query {
validateQuery(queryString:\"host=localhost\",
version: legacy, isLive: false)
{isValid, diagnostics{severity, message, code}}
}"
}
);
const options = {
hostname : '$YOUR_LOGSCALE_URL/graphql' ,
path : '/graphql' ,
port : 443 ,
method : 'POST' ,
headers : {
'Content-Type' : 'application/json' ,
'Content-Length' : data.length ,
Authorization : 'BEARER ' + process.env .TOKEN ,
'User-Agent' : 'Node' ,
},
};
const req = https.request (options, (res ) => {
let data = '' ;
console .log (`statusCode: ${res.statusCode} ` );
res.on ('data' , (d ) => {
data += d;
});
res.on ('end' , () => {
console .log (JSON .parse (data).data );
});
});
req.on ('error' , (error ) => {
console .error (error);
});
req.write (data);
req.end ();
For version , see
LanguageVersionEnum
. For
arguments , the datatype
QueryArgument
, there are a couple
parameters. Below is a list of them along with their datatypes and
a description of each:
The returned datatype QueryValidationResult
has its own parameters. They're listed in the table here:
Table: QueryValidationResult
Parameter Type Required Default Stability Description Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column. Table last updated: Oct 2, 2024 diagnostics
[QueryDiagnostic
] yes Preview
A diagnostic message from query validation. See QueryDiagnostic
. This is a preview for internal testing and subject to change. isValid
boolean yes Preview
Whether query is valid. For internal testing.