# IBaseSnapshot

> Language fallback: requested `zh-CN`; content is `en-US`.

- Human documentation: [https://docs.univer.ai/zh-CN/reference/types/base-snapshot](https://docs.univer.ai/zh-CN/reference/types/base-snapshot)

- Agent Markdown: [https://docs.univer.ai/zh-CN/reference/types/base-snapshot.md](https://docs.univer.ai/zh-CN/reference/types/base-snapshot.md)

- Requested language: `zh-CN`

- Content language: `en-US`

- Documentation version: `1.0.0-rc.0`

- Source: [types/base-snapshot.mdx](https://github.com/dream-num/documentation/blob/dev/content/reference/types/base-snapshot.mdx)

---

A Base snapshot containing its tables, table order, schema version, and metadata. Use the [Bases Facade](https://docs.univer.ai/zh-CN/reference/facade/base.md) to read or update live records and fields.

## Import

```ts
import type { IBaseSnapshot } from '@univerjs/core'
```

## Definition

```ts
interface IBaseSnapshot {
  id: BaseId
  name: string
  rev?: number
  appVersion?: string
  locale?: LocaleType
  schemaVersion: number
  tables: Record<TableId, ITableSnapshot>
  tableOrder: TableId[]
  createdAt: number
  updatedAt: number
  createdBy?: string
  resources?: IResources
}
```

## Fields

### `id`

Required · `string`

### `name`

Required · `string`

### `rev`

Optional · `number | undefined`

### `appVersion`

Optional · `string | undefined`

### `locale`

Optional · `LocaleType | undefined`

### `schemaVersion`

Required · `number`

### `tables`

Required · `Record<string, ITableSnapshot>`

### `tableOrder`

Required · `string[]`

### `createdAt`

Required · `number`

### `updatedAt`

Required · `number`

### `createdBy`

Optional · `string | undefined`

### `resources`

Optional · `IResources | undefined`

## Related types

* [`BaseId`](https://unpkg.com/@univerjs/core@1.0.0-rc.0/lib/types/bases/typedef.d.ts)
* [`LocaleType`](https://docs.univer.ai/zh-CN/reference/enums/locale-type.md)
* [`TableId`](https://unpkg.com/@univerjs/core@1.0.0-rc.0/lib/types/bases/typedef.d.ts)
* [`ITableSnapshot`](https://unpkg.com/@univerjs/core@1.0.0-rc.0/lib/types/bases/typedef.d.ts)
* [`Record`](https://unpkg.com/@typescript/typescript-darwin-arm64@7.0.2/lib/lib.es5.d.ts)
* [`IResources`](https://unpkg.com/@univerjs/core@1.0.0-rc.0/lib/types/services/resource-manager/type.d.ts)

**Package:** [`@univerjs/core`](https://docs.univer.ai/zh-CN/reference/packages/plugins/univerjs/core.md) · [Type definitions](https://unpkg.com/@univerjs/core@1.0.0-rc.0/lib/types/bases/typedef.d.ts)