Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vsivsi/meteor-cfs-gridfs

GridFS storage adapter for CollectionFS
https://github.com/vsivsi/meteor-cfs-gridfs

Last synced: 19 days ago
JSON representation

GridFS storage adapter for CollectionFS

Awesome Lists containing this project

README

        

cfs-gridfs
=========================

NOTE: This package is under active development right now (2014-2-20). It has
bugs and the API may continue to change. Please help test it and fix bugs,
but don't use in production yet.

A Meteor package that adds GridFS-like storage for
[CollectionFS](https://github.com/CollectionFS/Meteor-CollectionFS). When you
use this storage adapter, file data is stored in chunks in a `Meteor.Collection`
in your MongoDB database.

## Installation

Install using Meteorite. When in a Meteor app directory, enter:

```
$ mrt add cfs-gridfs
```

## Usage

```js
var imageStore = new FS.Store.GridFS("images", {
beforeSave: myBeforeSaveFunction, //optional
maxTries: 1 //optional, default 5
});

Images = new FS.Collection("images", {
stores: [imageStore]
});
```

Refer to the [CollectionFS](https://github.com/CollectionFS/Meteor-CollectionFS)
package documentation for more information.

## Notes

A GridFS store does not currently support the `sync` option.

## API

[For Users](https://github.com/CollectionFS/Meteor-cfs-gridfs/blob/master/api.md)

[For Contributors](https://github.com/CollectionFS/Meteor-cfs-gridfs/blob/master/internal.api.md)