Remy Reference/admin/DataSourceConnector

DataSourceConnector

Type

The S3 origin attached to a corpus: bucket, prefix, last sync, and tracked object counts.

The S3 origin attached to a corpus: the bucket, region, and prefix it follows, when it last synced and how many keys that walk listed, and any last error. On a direct read it also carries the live and deleted key counts the index tracks. This is what datasources connector returns.

DataSourceConnector.ts

interface DataSourceConnector {
  id: string
  type: 's3'
  bucket: string
  region: string
  prefix: string
  endpoint: string | null
  lastSyncedAt: string | null
  lastSyncObjectsListed: number | null
  lastError: string | null
  objects?: { live: number; deleted: number }
}

Fields

bucket

string

The S3 bucket the corpus reads from.

prefix

string

Key prefix followed; empty for the whole bucket.

lastSyncedAt

string | null

When the last sync ran.

lastSyncObjectsListed

number | null

Keys the last sync's walk listed: the bucket's size as of then.

objects?

{ live, deleted }

On GETHow many customer keys the index tracks, live and deleted. Only on a direct read.

Read the connector

const { connector } = await admin.dataSourceConnectors.get({ slug: 'docs' });
console.log(connector?.bucket, connector?.lastSyncedAt);