Streams

Introduction

Streams represent the data structures within your application. Use the Streams API to manage data structures.

If you want to access the data within a configured stream, use the Entries API.

List Streams

Display a paginated list of configured stream:

streams:list
    {--query= : Query constraints.}
    {--show= : Comma-seperated fields to display.}
    {--per-page=15 : Entries per page.}
    {--page= : Page to list.}

Response

php artisan streams:list --show=id,name --query=where:id,like,%docs%

Total: 5
Per Page: 15
Last Page: 1
Current Page: 1
+-----------+--------------------+
| id        | name               |
+-----------+--------------------+
| docs      | Laravel Streams    |
| docs_api  | Streams API        |
| docs_sdk  | SDK Documentation  |
| docs_core | Core Documentation |
| docs_ui   | Streams UI         |
+-----------+--------------------+

Create Stream

Create a new strean:

streams:create
    {input? : Query string formatted attributes.}
    {--update : Update if exists.}

Response

JSON OUTPUT

Show Stream

Display a single entry for a configured stream:

streams:show
    {stream : The entry stream.}
    {entry : The entry identifier.}
    {--show= : Comma-seperated fields to show.}c

Response

php artisan streams:show docs api

+------------+---------------+
| Field      | Value         |
+------------+---------------+
| id         | api           |
| sort       | 20            |
| stage      | review        |
| title      | API Readiness |
| category   | core_concepts |
| enabled    | 1             |
| publish_at |               |
| body       |               |
+------------+---------------+

Stream Schema

Display a JSON schema for the configured stream:

streams:schema
    {stream : The stream ID.}

Response

php artisan streams:schema docs

{
    ... @todo replace when ready
}