API リファレンス
ファイルインデックス
保存済みファイルインデックスをページ分割・並べ替えで検索し、同じ条件の件数を取得します。
Volume scan scheduling
volumeIdQUEUEDFIFO · deduplicate by volume
RUNNING × 1One scan at a time
Complete / fail / stop → next
pause → PAUSED · resume → QUEUED
型定義
graphql
type Subscription {
fileIndexScanProgressUpdated: FileIndexScanProgress!
}
type Query {
indexedFileCount(query: String!): Long!
indexedFiles(query: String!, offset: Int!, limit: Int!, sortBy: FileSortBy!): [File!]!
fileIndexDefaults: FileIndexDefaults!
fileIndexScanProgress(volumeId: ID): FileIndexScanProgress!
fileIndexVolumes: [FileIndexVolume!]!
}
type Mutation {
pauseFileIndex(volumeId: ID): Boolean!
rebuildFileIndex(volumeId: ID): Boolean!
resumeFileIndex(volumeId: ID): Boolean!
setFileIndexVolume(volumeId: ID!, input: FileIndexVolumeInput!): Boolean!
stopFileIndex(volumeId: ID): Boolean!
}
type File {
permission: String!
mediaId: ID
name: String!
path: String!
createdAt: Instant
updatedAt: Instant!
size: Long!
isDir: Boolean!
childCount: Int!
url: String!
isSystem: Boolean!
}
type FileIndexDefaults {
excludedDirs: [String!]!
excludedNames: [String!]!
excludedProfileDirs: [FileIndexProfileDir!]!
mediaExcludedDirSuffixes: [String!]!
}
enum FileIndexMode {
UNCONFIGURED
DISABLED
ALLOWLIST
BLOCKLIST
}
type FileIndexProfileDir {
profilesDir: String!
excludedDir: String!
exceptDirs: [String!]!
}
type FileIndexScanProgress {
volumeId: ID
indexed: Int!
pending: Int
total: Int
state: FileIndexScanState!
error: String
}
enum FileIndexScanState {
IDLE
QUEUED
RUNNING
PAUSED
STOPPED
FAILED
}
enum FileIndexScanStatus {
COMPLETED
CANCELED
FAILED
}
type FileIndexVolume {
id: ID!
path: String!
isAvailable: Boolean!
indexMode: FileIndexMode!
includedDirs: [String!]!
excludedDirs: [String!]!
lastScanAt: Instant
lastScanStatus: FileIndexScanStatus
lastScanCount: Long
lastScanTotal: Long
}
input FileIndexVolumeInput {
indexMode: FileIndexMode!
includedDirs: [String!]!
excludedDirs: [String!]!
}
enum FileSortBy {
UPDATED_AT_ASC
UPDATED_AT_DESC
SIZE_ASC
SIZE_DESC
NAME_ASC
NAME_DESC
}
scalar Instant
scalar Long操作
subscription
fileIndexScanProgressUpdated
ファイルインデックススキャンの進行状況更新を受信します。
graphql
subscription fileIndexScanProgressUpdated {
fileIndexScanProgressUpdated { volumeId indexed pending total state error }
}query
indexedFileCount
クエリに一致するインデックス済みファイル数を数えます。
graphql
query indexedFileCount($query: String!) {
indexedFileCount(query: $query)
}query
indexedFiles
保存済みのファイルインデックスを、ページ指定と並べ替えで検索します。
graphql
query indexedFiles($query: String!, $offset: Int!, $limit: Int!, $sortBy: FileSortBy!) {
indexedFiles(query: $query, offset: $offset, limit: $limit, sortBy: $sortBy) { permission mediaId name path createdAt updatedAt size isDir }
}mutation
pauseFileIndex
実行中のファイルインデックススキャンを一時停止します。
graphql
mutation pauseFileIndex($volumeId: ID) {
pauseFileIndex(volumeId: $volumeId)
}mutation
rebuildFileIndex
指定ボリュームのファイルインデックスを再構築します。volumeId を省略するか null にすると、設定済みの全ボリュームが対象です。
graphql
mutation rebuildFileIndex($volumeId: ID) {
rebuildFileIndex(volumeId: $volumeId)
}mutation
resumeFileIndex
一時停止したファイルインデックススキャンを再開します。
graphql
mutation resumeFileIndex($volumeId: ID) {
resumeFileIndex(volumeId: $volumeId)
}mutation
setFileIndexVolume
ボリュームのインデックス方式とディレクトリ設定を保存し、インデックスを更新します。
graphql
mutation setFileIndexVolume($volumeId: ID!, $input: FileIndexVolumeInput!) {
setFileIndexVolume(volumeId: $volumeId, input: $input)
}mutation
stopFileIndex
実行中のファイルインデックススキャンを停止します。
graphql
mutation stopFileIndex($volumeId: ID) {
stopFileIndex(volumeId: $volumeId)
}query
fileIndexDefaults
ファイルインデックスのデフォルト設定を読み取ります。
graphql
query fileIndexDefaults {
fileIndexDefaults { excludedDirs excludedNames mediaExcludedDirSuffixes }
}query
fileIndexScanProgress
ファイルインデックススキャンの現在の進行状況を読み取ります。
graphql
query fileIndexScanProgress($volumeId: ID) {
fileIndexScanProgress(volumeId: $volumeId) { volumeId indexed pending total state error }
}query
fileIndexVolumes
登録済みのファイルインデックスボリュームと、その設定を読み取ります。
graphql
query fileIndexVolumes {
fileIndexVolumes { id path isAvailable indexMode includedDirs excludedDirs lastScanAt lastScanStatus }
}