@lyra/export/README.md

Export Lyra documents and assets

# @lyra/export

Exports documents and assets from a Lyra dataset

## Installing

```
npm install --save @lyra/export
```

## Usage

```js
const exportDataset = require('@lyra/export')

exportDataset({
  // Instance of @lyra/client configured to correct project ID and dataset
  client: someInstantiatedLyraClientInstance,

  // Name of dataset to export
  dataset: 'myDataset',

  // Path to write zip-file to, or `-` for stdout
  outputPath: '/home/your-user/myDataset.zip',

  // Whether or not to export assets. Note that this operation is currently slightly lossy;
  // metadata stored on the asset document itself (original filename, for instance) might be lost
  // Default: `true`
  assets: false,

  // Exports documents only, without downloading or rewriting asset references
  // Default: `false`
  raw: true,

  // Whether or not to export drafts
  // Default: `true`
  drafts: true,

  // Export only given document types (`_type`)
  // Optional, default: all types
  types: ['products', 'shops']
})
```

## Future improvements

- Restore original filenames, keep track of duplicates, increase counter (`filename (<num>).ext`)
- Skip archiving on raw/no-asset mode?

## CLI-tool

This functionality is built in to the `@lyra/cli` package as `lyra dataset export`

## License

MIT-licensed. See LICENSE.