When you have created and saved a new Buffer, the Buffer edit dialog is immediately opened.

The edit dialog consists of four tabs:

Info

  • View basic info about the Buffer.

  • Displays an estimated number of records in the Buffer.

Info Options

  • Recalc Size
    Click to rescan and recount the actual number of records in the Buffer.

  • Purge
    Click to delete all records from the Buffer.
    ⚠️ This action cannot be undone.


Properties

  • Indexes - Creating indexes helps improve performance against the buffer.
    • Enables fast searches for lookups and queries.
    • Click the + icon to add key index fields, a sort field, and a unique flag, or
    • Click the </> icon to add key index fields using the MongoDB Extended JSON specification code.

  • Type - The type option lets you select the usage type for the data to be optimized in the Buffer.
    The available types are:
    Data - Use this usage type if you are predominantly searching and reading data.
    Transactional - Use this usage type if you are predominantly reading and writing data.
    Log - Use this usage type if you are predominantly writing data.

  • Cache Definition - This option sets a cache period for the Buffer definition in minutes.
    • The definition only includes the buffer's defined metadata, schema, indexes, etc. but not the buffer's data.
    • For example, if the cache period is set to five minutes, the Buffer definition will be re-cached in memory every five minutes.
    • A setting of zero minutes implies that there will be no caching.

  • Expire After (minutes) - This option sets a Time to Live (TTL) limit on the data in minutes.
    • When the expiry time is reached, all records in the buffer that are older than the expiry minutes will be deleted.
    • A setting of zero will not delete any records from the Buffer.

  • Save Buffer - Click Save to conclude.


Schema

A schema is generally the structure that defines the objects in a database.

  • The Schema tab provides functions to design and organize the data in a Buffer.

  • The Schema objects are also used to populate the field drop-down lists.

📝 A newly created or updated schema will not affect any data currently residing in the Buffer.


Schema Viewer
The schema viewer tab lets you visualize your schema at different levels.

Schema Viewer
  • Designer
    The schema designer tab lets you visually build and maintain your schema structure and metadata.

Designer
Raw Schema

Schema options

  • Regenerate Schema
    Click to regenerate the Buffers schema from a random sample of data.
    ⚠️ This option will overwrite the currently defined schema.

  • Save Schema
    Click to save the custom schema and all of the latest changes.


Version Control

Each Buffer is assigned a version number.

Version Control
  • Create New Version
    It would be good practice to create a new version copy after each change as a backup.

  • Checkout Version
    Use this option to update and replace the active Buffer's definition with a different version.
    • Select a previous version in the drop-down selection list.
    • Click the Checkout Version text button to activate the selected version.


Useful Tutorials

Revisit the Getting Started page for a refresher.

Read more about Flow Steps here.

Read more about Buffers here.


< Creating a Buffer Managing Buffer Values >

Did this answer your question?