The setOffsetForDatasourcesOnPartition() GraphQL mutation is used to set the starting read offset for the given ingest partition.

To update the starting point for an ingest partition, use the updateIngestPartitionScheme() mutation.

Hide Query Example

Show Ingest Partitions Query

API Stability Preview

Syntax

graphql
setOffsetForDatasourcesOnPartition(
      input: SetOffsetForDatasourcesOnPartitionInput!
   ): boolean

For the input, you'll have to provide the offset settings for datasources on partition type: the ingest partition to offset and by how much. See the Given Datatype section for details.

For results, this mutation returns true if successful.

Example

Raw
graphql
mutation {
  setOffsetForDatasourcesOnPartition( input:
    {
     partition: 4
     offset: 10
    }
  )
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  setOffsetForDatasourcesOnPartition( input:
    {
     partition: 4
     offset: 10
    }
  )
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  setOffsetForDatasourcesOnPartition( input:
    {
     partition: 4
     offset: 10
    }
  )
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  setOffsetForDatasourcesOnPartition( input: ^
    { ^
     partition: 4 ^
     offset: 10 ^
    } ^
  ) ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  setOffsetForDatasourcesOnPartition( input:
    {
     partition: 4
     offset: 10
    }
  )
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "mutation {
  setOffsetForDatasourcesOnPartition( input:
    {
     partition: 4
     offset: 10
    }
  )
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
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
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  setOffsetForDatasourcesOnPartition( input:
    {
     partition: 4
     offset: 10
    }
  )
}"
}'''

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

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  setOffsetForDatasourcesOnPartition( input:
    {
     partition: 4
     offset: 10
    }
  )
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  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
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "setOffsetForDatasourcesOnPartition": true
  }
}

Given Datatype

For input datatype, you have to give the ingest partition to set the starting offset, and the offset amount. These parameters are described below:

Table: SetOffsetForDatasourcesOnPartitionInput

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 19, 2024
offsetlongyes PreviewThe starting offset for the ingest partition.
partitionintegeryes PreviewThe ingest partition for which to set the offset.