diff --git a/docs/query-language.md b/docs/query-language.md index c2319cabd..5030db3cc 100644 --- a/docs/query-language.md +++ b/docs/query-language.md @@ -266,6 +266,32 @@ ClearRow(stargazer=1) This represents removing the relationship between the user with id=1 and all repositories. +#### Store + +**Spec:** + +``` +Store(, =) +``` + +**Description:** + +`Store` writes the results of to the specified row. If the row already exists, it will be replaced. The destination field must be of field type `set`. + +**Result Type:** boolean + +Upon success, this method always returns `true`. A future version of Pilosa may use this boolean result to indicate whether or not the data in the destination row was changed by the `Store` call. + +**Examples:** + +Store the contents of stargazer row 1 into stargazer row 2: +```request +Store(Row(stargazer=1), stargazer=2) +``` +```response +{"results":[true]} +``` + ### Read Operations #### Row