Repository | LogScale GraphQL Reference - Datatypes | LogScale Documentation

Skip to content

LogScale Documentation Full Library Knowledge Base Release Notes Integrations Training API GraphQL API Contacting Support

`Repository`

The Repository datatype includes various settings.

Deprecated: 1.120

The name argument to the parser field on the Repository datatype is deprecated in LogScale version 1.120 and will be removed in version 1.136.

Table: Repository

Parameter	Type	Argument	Argument Type	Required^[a]	Default	Description
`type`	`RepositoryType`	yes		Repository Types are used for tracking trial status in LogScale Cloud setups. It has an enumerated list of values from which to choose: `PERSONAL`, `TRIAL`, `DEFAULT`, `SYSTEM`, or `MANAGED`.
`dataType`	`RepositoryDataType`	yes		Repository data types are used for controlling the types of data are allowed in the repository. It has an enumerated list of values from which to choose: `FALCON`, or `ANYDATA`.
`limit`	`LimitV2`			This is the limit attached to the repository. See `LimitV2` table.
`ingestBlock`	datetime			The date and time in the future after which ingest for this repository will be re-enabled.
`usageTag`	string			The usage tag used to group usage summary on repositories.
`datasources`	[`Datasource`]	yes		Data sources from where data is ingested: specific log files or services sending data to LogScale (see `Datasource` Table).
`uncompressedByteSize`	long	yes		Total size the data, measured as the size stored before compression and is thus the size of the internal format, not the data that was ingested.
`compressedByteSize`	long	yes		Total size of data, measured as the size after compression.
`uncompressedByteSizeOfMerged`	long	yes		Total size the data, merged parts. Size is measured as the size stored before compression and is thus the size of the internal format, not the data that was ingested.
`compressedByteSizeOfMerged`	long	yes		Total size of data, merged parts. Size is measured as the size after compression.
`timeOfLatestIngest`	datetime	yes		The timestamp of the latest ingested data, or null if the repository is empty.
`timeBasedRetention`	float	yes		The maximum time in days to keep data. Older date will be deleted.
`ingestSizeBasedRetention`	float			Retention in gigabytes, based on the size of data when it arrives at LogScale, before parsing and compression. LogScale will keep at most this amount of data.
`ingestTokens`	[`IngestToken`]	yes		The ingest token used for receiving data into the repository (see `IngestToken` Table).
`storageSizeBasedRetention`	float			Retention in gigabytes, based on the size of data when in storage, after parsing and compression. LogScale will keep at least this amount of data, but as close to this amount as possible.
`timeBasedBackupRetention`	float			Sets time in days to keep back-ups before they are deleted.
`ingestListeners`	[`IngestListener`]	yes		The ingest listeners configured for this repository (see `IngestListener` Table).
`maxAutoShardCount`	integer			The maximum number of auto shards created.
`s3ArchivingConfiguration`	`S3Configuration`	yes		The configuration for S3 archiving (e.g., bucket name and region) See `S3Configuration` Table.
`cachePolicy`	`CachePolicy`	yes		The cache policy set on the repository. Cache policies are a limited feature and subject to change (see `CachePolicy` Table).
`effectiveCachePolicy`	`CachePolicy`	yes		The effective cache policy that will apply to the repository, organization or global default, in order of precedence is: the repository cache policy, if set; the organization cache policy, if set; the global cache policy, if set; or the default cache policy in which no segments are prioritized. Cache policies are a limited feature and subject to change (see `CachePolicy` Table).
`currentTagGroupings`	[`TagGroupingRule`]	yes		Tag grouping rules applied on the repository currently. Rules only apply to the tags they denote, and tags without rules do not have any grouping. See `TagGroupingRule` table.
`eventForwardingRules`	[`EventForwardingRule`]	yes		The event forwarding rules configured for the repository (see `EventForwardingRule` Table).
`eventForwardersForSelection`	[`EventForwarderForSelection`]	yes		List event forwarders in the organization with only basic information (see `EventForwarderForSelection` Table).
`fdrFeed`	(id: string): `FdrFeed`	yes		The unique identifier of the FDR feed to get (see `fdrFeed` Table).
`fdrFeeds`	[`FdrFeed`]	yes		Saved FDR feeds (see `fdrFeed` Table).
`fdrFeedControl`	(id: string): maxNodes:long	yes		Administrator control for an FDR feed. Provide the identifier of the FDR feed the administrator is to control. The maxNodes is the maximum number of nodes with which to poll the FDR feed. This feature is a preview and is still being iterated; changes may occur.
`fdrFeedControls`	[`FdrFeedControl`]	yes		Administrator controls for FDR feeds. This feature is still being iterated; changes may occur. See `fdrFeedControl` Table.
`ingestFeed`	(id: string): `IngestFeed`	yes		A saved Ingest feed. This is a experimental feature: It's not ready for production. See the `IngestFeed` table.
`ingestFeeds`	(various): `IngestFeedQueryResultSet`	yes		Saved Ingest feeds. This is a experimental feature: It's not ready for production. See the `IngestFeed` and the `IngestFeedQueryResultSet` table. The various input parameters are `searchFilter: string, typeFilter: [IngestFeeds__Type!], sortBy: IngestFeeds__SortBy! = CreatedTimeStamp, orderBy: OrderBy = ASC, skip: Int = 0, limit: Int = 50)`, with a return datatype of `IngestFeedQueryResultSet!`. The `searchFilter` is the basis for filtering results. The `typeFilter` is type of ingest feed to filter. The only value at this time is `AwsS3Sqs`. The `sortBy` accepts `CreatedTimeStamp`. Use the `orderBy` to choose the order of results returned. The `skip` is to specify the number of results to skip or the offset to use. For instance, for pagination set `skip = limit (page - 1)`. Finally, `limit`* is the amount of results to return.
`awsExternalId`	string	yes		The AWS External identifier used by new ingest feeds in this repository. This is still an experimental feature and is not ready for production. (see `Parser` Table).
`parser`	Returned type: `Parser`			The Parser in the repository (see `Parser` Table).
	Arguments:
		`name`	string	The name of the parser
`parsers`	[`Parser`]	yes		List of parsers used with the repository (see `Parser` Table).
`id`	string	yes		The unique identifier of the repository.
`name`	`RepoOrViewName`	yes		This is just a scalar. It's the name of the repository. Despite its label, for the `repository` datatype, it returns only the name of the repository, not a view name. See searchDomains() to get the view name.
`description`	string			A description of the repository.
`deletedDate`	long			The point in time the search domain was marked for deletion.
`permanentlyDeletedAt`	long			The point in time the search domain will not be restorable anymore.
`isStarred`	boolean	yes		Whether the repository is marked with a star.
`packageV2`	Returned type: `Package2`	yes		The returned package information for the specified package (see `Package2` table).
	Arguments:
		`packageId`	VersionedPackageSpecifier	The repository package to return information for.
`packageVersions`	string	yes		The available versions of a package. This is a preview and may be moved to the Package2 object.
`availablePackages`	string	yes		Returns a list of available packages that can be installed. The various input are `filter: string, tags: [PackageTag], categories: [string]`. The `filter` is the filter input to limit the returned packages. The `tags` are packages with any of these tags will be included. No filtering on tags. `PackageTag` is a scalar. Last, `categories` are the categories of packages to include. For the return value, see the `PackageRegistrySearchResultItem` table.
`installedPackages`	[`PackageInstallation`]	yes		List packages installed on a specific view or repository (see `PackageInstallation` Table).
`hasPackageInstalled`	(packageId: `VersionedPackageSpecifier`): boolean	yes		Whether the repository has a given package installed. VersionedPackageSpecifier is a scalar value.
`users`	[`User`]	yes		Users who have access to the repository (see `User` Table).
`usersAndGroups`	Returned type: `UsersAndGroupsSearchResultSet`	yes		Users or groups who have access to the repository.
	Arguments:
		`skip`	String	The number of results to skip (i.e. the offset) to use.
		`limit`	Int	The number of results to return.
`skip`	`String`	yes		The number of results to skip (i.e. the offset) to use.
`limit`	`Int`	yes		The number of results to return.
`usersV2`	[`User`]	yes		Used to search for a user whose email or name matches this search string. The `search` is to specify the user whose email or name matches for which to search. the `permissionFilter` is the permission that the users must have on the search domain. Leave out to get users with any permission on the view (see `Permission` table). The `skip` is the number of results to skip or the offset to use. Whereas `limit` is the amount of results to return. See the `User` table for the return results value.
`groups`	[`Group`]	yes		Groups with assigned roles (see `Group` Table).
`starredFields`	[string]	yes		A list of fields which are marked with a star in the repository.
`recentQueriesV2`	[`RecentQuery`]	yes		Any recent queries (see `RecentQuery` table).
`automaticSearch`	boolean	yes		Whether to search automatically.
`isActionAllowed`	(action: `ViewAction`): boolean	yes		Check if the current user is allowed to perform the given action on the view (see `ViewAction` Table).
`allowedViewActions`	[`ViewAction`]	yes		Returns the all actions the user is allowed to perform on the view (see `ViewAction` table).
`viewerQueryPrefix`	string	yes		The query prefix prepended to each search in this domain.
`tags`	[string]	yes		All tags from all datasources.
`interactions`	[`ViewInteraction`]	yes		All interactions defined on the view. See `ViewInteraction` table.
`alert`	(id: string): `Alert`	yes		A saved alert (see `Alert` Table).
`alerts`	[`Alert`]	yes		Saved alerts (see `Alert` Table).
`dashboard`	(id: string): `Dashboard`	yes		A saved dashboard (see `Dashboard` Table).
`dashboards`	[`Dashboard`]	yes		All dashboards available on the view (see `Dashboard` Table).
`filterAlert`	(id: `String`!): `FilterAlert`	yes		A saved filter alert (see `FilterAlert` Table). This has been deprecated since March 4, 2021. Field is duplicated. Use instead savedQueries.
`filterAlerts`	[`FilterAlert`]	yes		Saved filter alerts (see `FilterAlert` Table).
`scheduledSearch`	(id: string): `ScheduledSearch`	yes		A saved scheduled search. The unique identifier of the scheduled search to get. See `ScheduledSearch` Table.
`scheduledSearches`	[`ScheduledSearch`]	yes		Saved scheduled searches (see `ScheduledSearch` Table).
`action`	(id: string): `Action`	yes		A saved action. The identifier of the action to get (see `Action` Table).
`actions`	[`Action`]	yes		A list of saved actions (see `Action` Table).
`savedQuery`	(id: string!): `SavedQuery`	yes		A saved query (see `SavedQuery` Table).
`savedQueries`	[`SavedQuery`]	yes		Saved queries (see `SavedQuery` Table).
`defaultQuery`	`SavedQuery`			The default saved query for the repository (see `SavedQuery` Table).
`fileFieldSearch`	(various): [`DictionaryEntryType`]	yes		The `fileName` is the name of the csv or json file from which to retrieve field entries. The `fieldName` is the name of the field in the file from which to return entries. The `prefixFilter` the text on which to filter values by prefix. The `valueFilters` is the exact values that given fields should have for an entry to be part of the result. The `fieldsToInclude` are the names of the fields to include in the result. The `maxEntries` is the maximum number of values to retrieve from the file. For the return values, see the `DictionaryEntryType` table.
^[a]Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.

Enter search term