Skip to content

Commit

Permalink
Edit description of flushc() (#24)
Browse files Browse the repository at this point in the history
  • Loading branch information
lens0021 authored Jun 17, 2021
1 parent 2cefe45 commit 5e15feb
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion api-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ after connecting to Ingest channel you can call the following methods on it
| `->push(string $collection,string $bucket, string $object_id, string "data", [string <locale>])` | Add an item to index and Returns a Sonic Response, locale is optional, which should be a valid [ISO 639-3](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) locale (eng = English), if set to `none` lexing will be disabled |
| `->pop(string $collection,string $bucket, string $object_id, string "data"` | pops an item out of index and returns a Sonic Response |
| `->count(string $collection,[string $bucket, [string $object_id]]): int` | counts the number of items in collection, bucket or object |
| `->flushc(string $collection):int` | Flushes the buckets from a collection, returns a integer saying the number of items flushed |
| `->flushc(string $collection):int` | Flushes the objects from a collection, returns a integer saying the number of items flushed |
| `->flushb(string $collection, string $bucket):int` | Flushes the objects from a bucket, returns a integer saying the number of items flushed |
| `->flusho(string $collection, string $bucket, string $object_id):int` | Flushes the indexed text from an objects, returns a integer saying the number of items flushed |
| `->ping(): string` | Pings the server, should return _PONG_ |
Expand Down

0 comments on commit 5e15feb

Please sign in to comment.