API Stability Long-Term

The updateFile() GraphQL mutation may be used to change a file in LogScale.

For information on loading and using files, see the Lookup Files documentation page.

Syntax

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

graphql
updateFile(
     fileName: string!
     name: string!
     changedRows: [[string!]!]!
     headers: [string!]!
     columnChanges: [ColumnChange!]!
     limit: integer
     offset: integer
   ): UploadedFileSnapshot!

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

Show:
graphql
mutation {
  updateFile( 
       fileName: "somefile.csv",
       name: "humio",
       changedRows: [ "some", "thing"],
       headers: [ "my-header" ],
       columnChanges: [ { changeKind: Remove, index: 1 } ]
  )
  { lines }
}
Example Responses
Show:
json
{
  "data": {
    "updateFile": {
      "lines": "4"
    }
  }
}

Given Datatypes

For ColumnChange, there are a couple of parameters that may be given. Below is a list of them along with a description of each:

Table: ColumnChange

ParameterTypeRequiredDefaultStabilityDescription
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 17, 2024
changeKindColumnChangeKindyes Long-TermThe kind of column change. See ColumnChangeKind.
indexintegeryes Long-TermThe index of the column to change.

Returned Datatypes

The returned datatype UploadedFileSnapshot has several parameters. Below is a list of them along with a description of each:

Table: UploadedFileSnapshot

ParameterTypeRequiredDefaultStabilityDescription
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: Mar 27, 2025
filterStringstring  Long-TermAny string on which to filter the data.
headers[string]yes Long-TermThe headers for the uploaded snapshot file.
limitintegeryes Long-TermThe file upload limit.
lines[string]yes Long-TermThe contents of the file in the form of a list of lines, with each line being itself a list of column values. When the file is empty or nothing matches filterString, then [] is returned.
nameAndPathFileNameAndPathyes Long-TermThe name and path of the uploaded snapshot file. See FileNameAndPath.
offsetintegeryes Long-TermThis is the offset supplied to a file query. For a new or updated file, this is always 0.
resourcestring  Short-TermThe resource identifier for the file.
totalLinesCountlongyes Long-TermThe total number of lines in the uploaded snapshot file.