Skip to main content
Altcraft Docs LogoAltcraft Docs Logo
User guideDeveloper guideAdmin guide
Company siteHelp center
English
  • Русский
  • English
v73
  • v74
  • v73
  • v72
Login
  • Getting Started
  • Administrator documentation
  • Functional characteristics
  • Technology description
  • System requirements
  • Admin Panel
  • Platform installation
  • Platform configuration
  • Platform maintenance
  • Custom channels guide
    • Overview
    • Creating and configuring a channel
    • Entity field configuration
    • Template language
    • Entities
    • Pipes
      • Pipe: Basic Concepts
      • Result
      • Errors
      • Log
      • Pack
      • Unpack
      • HTTP Request
      • Store Set
      • Store Get
      • Selector
      • SQL
      • Eventer
      • Scheduler
    • Pipelines
  • Extra
  • Processing HTTP/HTTPS traffic
  • Administrator API
This is documentation for Altcraft Platform v73. This documentation is no longer maintained.
The information for up-to-date platform version at this page is available (v74).
  • Custom channels guide
  • Pipes
  • Store Get
Documentation for version v73

Store Get

Description​

Store Get the pipe takes data from mongodb for a given key and writes it to $in.<name/>.

Stucture​

FieldType of valueExampleRequiredDescription
idnumber10yesPipe's ID
typestring"store_get"yesType of a pipe
paramsStoreGetParamsObject
noType-specific parameters
outsOutsObject
noPipe's outputs

StoreGetParamsObject
FieldTypeExampleReqieredDefaultDescription
key

string

"key_name"yes-Key name
name

string

"name"no<key>

Name of the field where value will be written ($in.<name>)

deletebooltruenofalseFlag for deleting a record immediately after it is read.
table

string

"some"no""

The name of the virtual collection into which the key-value pair will be written. From an implementation point of view, it’s just a tag. Therefore, it does not require any additional database configuration.

not_foundnumber12no-

ID of the pipe to which the event will go if a record for the given key is not found.

Errors​

  1. Error processing params.key and params.table - the template is incorrect or the field was not found.

  2. Error when querying the database, except Not found, if params.not_found is specified

Example​

{
"id": 2,
"type": "store_get",
"params": {
"key": "session_id",
"not_found": 3
},
"outs": {
"success": 28,
"error": 14
}
}
Last updated on Jul 11, 2022
Previous
Store Set
Next
Selector
  • Description
  • Stucture
  • Errors
  • Example
© 2015 - 2025 Altcraft, LLC. All rights reserved.