fileSchemaResults

Returns a paginated list of analyzed columns for a file's schema, filtered and sorted by data type relevance.

Arguments

Argument	Type	Description
first	Int	Returns the first n elements from the list.
after	String	An opaque cursor returned from a previous query's endCursor field. Pass this value verbatim to retrieve the next page of results.
last	Int	Returns the last n elements from the list.
before	String	An opaque cursor returned from a previous query's startCursor field. Pass this value verbatim to retrieve the previous page of results.
dataTypeIdsFilter	[String!]	Data type IDs to filter.
snapshotFid (required)	String!	FID of the snapshot to analyze.
snappableFid (required)	String!	FID of the object whose file schema results are requested.
stdPath (required)	String!	The standard path of the file/directory to browse.
filter	FileStructureFiltersInput	Optional filter for data type IDs.
sort	FileStructureSortInput	Optional sort configuration.

Returns

AnalyzedColumnConnection!

Sample

QueryVariablesExample Response

query FileSchemaResults($snapshotFid: String!, $snappableFid: String!, $stdPath: String!) {
  fileSchemaResults(
    snapshotFid: $snapshotFid
    snappableFid: $snappableFid
    stdPath: $stdPath
    first: 10
  ) {
    nodes {
      columnName
      columnType
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

{
  "snapshotFid": "example-string",
  "snappableFid": "example-string",
  "stdPath": "example-string"
}

{
  "data": {
    "fileSchemaResults": {
      "nodes": [
        [
          {
            "columnName": "example-string",
            "columnType": "SCHEMAFIELDTYPE_ARRAY"
          }
        ]
      ],
      "pageInfo": {
        "endCursor": "example-string",
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "example-string"
      }
    }
  }
}