addFunctionsToAllowList()

API Stability	`Preview`

The addFunctionsToAllowList() GraphQL mutation is used to enable functions for use with a specified language version. This field is not yet available. It's described here as a preview and is used only for internal testing.

This is an experimental feature, not ready for production.

For more information on functions, see the Function Syntax reference page.

Syntax

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

graphql

addFunctionsToAllowList(
      input: FunctionListInput!
    ): boolean!

For addFunctionsToAllowList(), there is one parameter, a boolean, that may be given: Whether to enable functions for use with a specified language version. This is a preview and for internal testing. See FunctionListInput below.

Below is an example of how this mutation field might be used:

Show:

graphql

mutation {
  addFunctionsToAllowList(input: 
     {version: legacy, 
      functions: ["count", "groupby", "in"] } )
}

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  addFunctionsToAllowList(input: 
     {version: legacy, 
      functions: [\"count\", \"groupby\", \"in\"] } )
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  addFunctionsToAllowList(input: 
     {version: legacy, 
      functions: [\"count\", \"groupby\", \"in\"] } )
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  addFunctionsToAllowList(input:  ^
     {version: legacy,  ^
      functions: [\"count\", \"groupby\", \"in\"] } ) ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  addFunctionsToAllowList(input: 
     {version: legacy, 
      functions: [\"count\", \"groupby\", \"in\"] } )
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"

perl

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation {
  addFunctionsToAllowList(input: 
     {version: legacy, 
      functions: [\"count\", \"groupby\", \"in\"] } )
}"
}';
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

#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  addFunctionsToAllowList(input: 
     {version: legacy, 
      functions: [\"count\", \"groupby\", \"in\"] } )
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)

javascript

const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  addFunctionsToAllowList(input: 
     {version: legacy, 
      functions: [\"count\", \"groupby\", \"in\"] } )
}"
}
);


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();

Example Responses

Show:

json

{
  "data": {
    "addFunctionsToAllowList": true
  }
}

Given Data Types

Within the parameters of the addFunctionsToAllowList input, there is the FunctionListInput mutation datatype, which has a couple of parameters.

Table: FunctionListInput

Parameter	Type	Required	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: Sep 18, 2024
`functions`	[string]	yes	`Preview`	The list of functions.
`version`	`LanguageVersionEnum`	yes	`Preview`	The version of the LogScale query language to use. See `LanguageVersionEnum`.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes