PS.FarNet.Redis.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Open-Redis</command:name> <maml:description> <maml:para>Opens and returns the specified Redis database.</maml:para> </maml:description> <command:verb>Open</command:verb> <command:noun>Redis</command:noun> </command:details> <maml:description> <maml:para>This command connects to Redis and returns the database instance. Keep it as the variable $db. Other commands use the variable $db as the default value of the parameter Database. You may close the database by Close-Redis. Or keep it for using later. If you use the same configuration string then the same database instance is returned. When $env:FARNET_REDIS_CONFIGURATION is defined, you may call Open-Redis without parameters in order to open this kind of default database.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Open-Redis</maml:name> <command:parameter required="false" position="named" > <maml:name>Prefix</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Open-Redis</maml:name> <command:parameter required="true" position="0" > <maml:name>Configuration</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Prefix</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>AllowAdmin</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Configuration</maml:name> <maml:description> <maml:para>Specifies the Redis configuration string. Examples: "127.0.0.1:3278" "127.0.0.1:3278,AllowAdmin=true" Note that 127.0.0.1 seems to work faster than localhost.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>AllowAdmin</maml:name> <maml:description> <maml:para>Tells to allow admin operations.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Prefix</maml:name> <maml:description> <maml:para>Specifies the key prefix and tells to return the prefixed database. See Use-RedisPrefix for the details.</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>StackExchange.Redis.IDatabase</maml:name> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Close-Redis</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Use-RedisPrefix</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Save-Redis</command:name> <maml:description> <maml:para>Explicitly requests to persist the current state to disk.</maml:para> </maml:description> <command:verb>Save</command:verb> <command:noun>Redis</command:noun> </command:details> <maml:description> <maml:para>This command calls Save(BackgroundSave) and waits for LastSave() changed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Save-Redis</maml:name> <command:parameter required="false" position="0" > <maml:name>Configuration</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0" > <maml:name>Configuration</maml:name> <maml:description> <maml:para>Specifies the Redis configuration string. Examples: "127.0.0.1:3278" "127.0.0.1:3278,AllowAdmin=true" Note that 127.0.0.1 seems to work faster than localhost.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Close-Redis</command:name> <maml:description> <maml:para>Closes the Redis database.</maml:para> </maml:description> <command:verb>Close</command:verb> <command:noun>Redis</command:noun> </command:details> <maml:description> <maml:para>This command closes the database from Open-Redis.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Close-Redis</maml:name> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> </command:parameters> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Open-Redis</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-RedisServer</command:name> <maml:description> <maml:para>Gets the database server instance.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>RedisServer</command:noun> </command:details> <maml:description> <maml:para>Gets the database server instance.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RedisServer</maml:name> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>StackExchange.Redis.IServer</maml:name> </dev:type> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Use-RedisPrefix</command:name> <maml:description> <maml:para>Gets a prefixed database.</maml:para> </maml:description> <command:verb>Use</command:verb> <command:noun>RedisPrefix</command:noun> </command:details> <maml:description> <maml:para>This command returns a new database that provides an isolated key space of the specified underlying database. The underlying database may be prefixed, too, in this case the specified prefix works as sub-prefix. With such a prefixed database input keys are automatically prefixed for all commands. Note that output keys are still absolute. If all operations use the same key prefix then you may open the prefixed database right away by Open-Redis -Prefix.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Use-RedisPrefix</maml:name> <command:parameter required="true" position="0" > <maml:name>Prefix</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Prefix</maml:name> <maml:description> <maml:para>Specifies the prefix that defines a key space isolation for the returned database. If the underlying database is prefixed, the prefix works as sub-prefix.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>StackExchange.Redis.IDatabase</maml:name> </dev:type> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Open-Redis</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-RedisAny</command:name> <maml:description> <maml:para>Gets the specified key value.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>RedisAny</command:noun> </command:details> <maml:description> <maml:para>Use this command when a type is unknown or defined as a variable. When the type is known, use type specific cmdlets Get-Redis{Type}.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RedisAny</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1" > <maml:name>Type</maml:name> <command:parameterValue required="true">RedisType</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <maml:description> <maml:para>Specifies the Redis key.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="1" > <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the expected value type.</maml:para> <maml:para>Values : None, String, List, Set, SortedSet, Hash, Stream, Unknown</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>when key is String</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> </dev:type> <maml:description> <maml:para>when key is Hash</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List[System.String]</maml:name> </dev:type> <maml:description> <maml:para>when key is List</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.HashSet[System.String]</maml:name> </dev:type> <maml:description> <maml:para>when key is Set</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-RedisHash</command:name> <maml:description> <maml:para>Gets the hash or its details.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>RedisHash</command:noun> </command:details> <maml:description> <maml:para>Gets the hash or its details.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RedisHash</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1" > <maml:name>Field</maml:name> <command:parameterValue required="true">RedisValue[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RedisHash</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Count</maml:name> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RedisHash</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Pattern</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <maml:description> <maml:para>Specifies the Redis key.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="1" > <maml:name>Field</maml:name> <maml:description> <maml:para>Gets values of the specified fields, including nulls for missing fields. If this parameter is omitted then the whole hash is returned as hashtable.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Count</maml:name> <maml:description> <maml:para>Gets the number of items.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Pattern</maml:name> <maml:description> <maml:para>Specifies the search pattern in one of two forms. (1) Without `[` and `]`, treated as simple pattern with `*` and `?` as wildcard characters and all other characters as literal. (2) With `[` or `]`, treated as glob-style pattern with `*`, `?`, `[]`, `[^]` and character `\` used for escaping literal characters. The result is Hashtable of found keys and values.</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>with Field</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Int64</maml:name> </dev:type> <maml:description> <maml:para>with Count</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-RedisList</command:name> <maml:description> <maml:para>Gets the list items or details.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>RedisList</command:noun> </command:details> <maml:description> <maml:para>Gets the list items or details.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RedisList</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RedisList</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Count</maml:name> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RedisList</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Index</maml:name> <command:parameterValue required="true">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <maml:description> <maml:para>Specifies the Redis key.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Count</maml:name> <maml:description> <maml:para>Gets the number of items.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Index</maml:name> <maml:description> <maml:para>Gets an item by the specified index. Negative indexes are used to get items from the tail, e.g. -1 is the last item.</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Int64</maml:name> </dev:type> <maml:description> <maml:para>with Count</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-RedisSet</command:name> <maml:description> <maml:para>Gets the set members or details.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>RedisSet</command:noun> </command:details> <maml:description> <maml:para>Gets the set members or details.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RedisSet</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RedisSet</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Count</maml:name> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RedisSet</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Pattern</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <maml:description> <maml:para>Specifies the Redis key.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Count</maml:name> <maml:description> <maml:para>Gets the number of items.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Pattern</maml:name> <maml:description> <maml:para>Specifies the search pattern in one of two forms. (1) Without `[` and `]`, treated as simple pattern with `*` and `?` as wildcard characters and all other characters as literal. (2) With `[` or `]`, treated as glob-style pattern with `*`, `?`, `[]`, `[^]` and character `\` used for escaping literal characters. The result is strings matching the pattern.</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Int64</maml:name> </dev:type> <maml:description> <maml:para>with Count</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-RedisString</command:name> <maml:description> <maml:para>Gets the string or its details.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>RedisString</command:noun> </command:details> <maml:description> <maml:para>Gets the string or its details.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RedisString</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>TimeToLive</maml:name> <command:parameterValue required="true">Nullable[TimeSpan]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RedisString</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Length</maml:name> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RedisString</maml:name> <command:parameter required="true" position="named" > <maml:name>Many</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <maml:description> <maml:para>Specifies the Redis key.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Length</maml:name> <maml:description> <maml:para>Gets the string length.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Many</maml:name> <maml:description> <maml:para>Gets several specified strings.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>TimeToLive</maml:name> <maml:description> <maml:para>Tells to update the time to live. Null will remove expiry.</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Int64</maml:name> </dev:type> <maml:description> <maml:para>with Length</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-RedisHash</command:name> <maml:description> <maml:para>Sets or updates the hash.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>RedisHash</command:noun> </command:details> <maml:description> <maml:para>Sets or updates the hash.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RedisHash</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1" > <maml:name>Field</maml:name> <command:parameterValue required="true">RedisValue</command:parameterValue> </command:parameter> <command:parameter required="true" position="2" > <maml:name>Value</maml:name> <command:parameterValue required="true">RedisValue</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>When</maml:name> <command:parameterValue required="true">When</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RedisHash</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1" > <maml:name>Field</maml:name> <command:parameterValue required="true">RedisValue</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Add</maml:name> <command:parameterValue required="true">Double</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RedisHash</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1" > <maml:name>Field</maml:name> <command:parameterValue required="true">RedisValue</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Decrement</maml:name> <command:parameterValue required="true">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RedisHash</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1" > <maml:name>Field</maml:name> <command:parameterValue required="true">RedisValue</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Increment</maml:name> <command:parameterValue required="true">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RedisHash</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1" > <maml:name>Field</maml:name> <command:parameterValue required="true">RedisValue</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Subtract</maml:name> <command:parameterValue required="true">Double</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RedisHash</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1" > <maml:name>Many</maml:name> <command:parameterValue required="true">IDictionary</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RedisHash</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Remove</maml:name> <command:parameterValue required="true">RedisValue[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <maml:description> <maml:para>Specifies the Redis key.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="1" > <maml:name>Field</maml:name> <maml:description> <maml:para>Specifies the field.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="1" > <maml:name>Many</maml:name> <maml:description> <maml:para>Specifies the fields and values.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="2" > <maml:name>Value</maml:name> <maml:description> <maml:para>Specifies the field value.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Add</maml:name> <maml:description> <maml:para>Adds the specified real number and gets the result [double]. Existing values should be numbers, missing are treated as 0.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Decrement</maml:name> <maml:description> <maml:para>Decrements by the specified integer and gets the result [long]. Existing values should be integers, missing are treated as 0.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Increment</maml:name> <maml:description> <maml:para>Increments by the specified integer and gets the result [long]. Existing values should be integers, missing are treated as 0.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Remove</maml:name> <maml:description> <maml:para>Removes the specified fields.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Subtract</maml:name> <maml:description> <maml:para>Subtracts the specified real number and gets the result [double]. Existing values should be numbers, missing are treated as 0.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>When</maml:name> <maml:description> <maml:para>Specifies when to set the field and gets the result: Always: true: new field false: updated old field NotExists: true: new field false: old field, not updated</maml:para> <maml:para>Values : Always, Exists, NotExists</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para>with When</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-RedisList</command:name> <maml:description> <maml:para>Sets or updates the list.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>RedisList</command:noun> </command:details> <maml:description> <maml:para>Sets or updates the list.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RedisList</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1" > <maml:name>RightPush</maml:name> <command:parameterValue required="true">Object[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RedisList</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>LeftPop</maml:name> <command:parameterValue required="true">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RedisList</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>LeftPush</maml:name> <command:parameterValue required="true">Object[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RedisList</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>RightPop</maml:name> <command:parameterValue required="true">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <maml:description> <maml:para>Specifies the Redis key.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="1" > <maml:name>RightPush</maml:name> <maml:description> <maml:para>Insert the specified items at the tail.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>LeftPop</maml:name> <maml:description> <maml:para>Removes and returns the specified number of items at the head.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>LeftPush</maml:name> <maml:description> <maml:para>Insert the specified items at the head.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>RightPop</maml:name> <maml:description> <maml:para>Removes and returns the specified number of items at the tail.</maml:para> </maml:description> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-RedisNumber</command:name> <maml:description> <maml:para>Sets or updates the number.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>RedisNumber</command:noun> </command:details> <maml:description> <maml:para>Sets or updates the number.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RedisNumber</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1" > <maml:name>Value</maml:name> <command:parameterValue required="true">Double</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>TimeToLive</maml:name> <command:parameterValue required="true">Nullable[TimeSpan]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>When</maml:name> <command:parameterValue required="true">When</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RedisNumber</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Add</maml:name> <command:parameterValue required="true">Double</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RedisNumber</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Decrement</maml:name> <command:parameterValue required="true">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RedisNumber</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Increment</maml:name> <command:parameterValue required="true">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RedisNumber</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Subtract</maml:name> <command:parameterValue required="true">Double</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <maml:description> <maml:para>Specifies the Redis key.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="1" > <maml:name>Value</maml:name> <maml:description> <maml:para>The new number.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Add</maml:name> <maml:description> <maml:para>Adds the specified real number and gets the result [double]. Existing values should be numbers, missing are treated as 0.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Decrement</maml:name> <maml:description> <maml:para>Decrements by the specified integer and gets the result [long]. Existing values should be integers, missing are treated as 0.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Increment</maml:name> <maml:description> <maml:para>Increments by the specified integer and gets the result [long]. Existing values should be integers, missing are treated as 0.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Subtract</maml:name> <maml:description> <maml:para>Subtracts the specified real number and gets the result [double]. Existing values should be numbers, missing are treated as 0.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>TimeToLive</maml:name> <maml:description> <maml:para>Specifies the time to live.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>When</maml:name> <maml:description> <maml:para>Specifies when the values should be set and returns true if keys were set and false otherwise.</maml:para> <maml:para>Values : Always, Exists, NotExists</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Int64</maml:name> </dev:type> <maml:description> <maml:para>with Increment, Decrement</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Double</maml:name> </dev:type> <maml:description> <maml:para>with Add, Subtract</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para>with When</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-RedisSet</command:name> <maml:description> <maml:para>Sets or updates the set.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>RedisSet</command:noun> </command:details> <maml:description> <maml:para>Sets or updates the set.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RedisSet</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1" > <maml:name>Add</maml:name> <command:parameterValue required="true">Object[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RedisSet</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Remove</maml:name> <command:parameterValue required="true">Object[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <maml:description> <maml:para>Specifies the Redis key.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="1" > <maml:name>Add</maml:name> <maml:description> <maml:para>Adds the specified items.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Remove</maml:name> <maml:description> <maml:para>Removes the specified items.</maml:para> </maml:description> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-RedisString</command:name> <maml:description> <maml:para>Sets or updates the string.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>RedisString</command:noun> </command:details> <maml:description> <maml:para>Sets or updates the string.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RedisString</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1" > <maml:name>Value</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>TimeToLive</maml:name> <command:parameterValue required="true">Nullable[TimeSpan]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>When</maml:name> <command:parameterValue required="true">When</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RedisString</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>SetAndGet</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>TimeToLive</maml:name> <command:parameterValue required="true">Nullable[TimeSpan]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RedisString</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Append</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RedisString</maml:name> <command:parameter required="true" position="named" > <maml:name>Many</maml:name> <command:parameterValue required="true">IDictionary</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>When</maml:name> <command:parameterValue required="true">When</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <maml:description> <maml:para>Specifies the Redis key.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="1" > <maml:name>Value</maml:name> <maml:description> <maml:para>The new string.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Append</maml:name> <maml:description> <maml:para>Appends the specified string and gets the result string length.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Many</maml:name> <maml:description> <maml:para>Sets several strings specified as hashtable or dictionary.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>SetAndGet</maml:name> <maml:description> <maml:para>Atomically sets the specified string and returns the old string.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>TimeToLive</maml:name> <maml:description> <maml:para>Specifies the time to live.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>When</maml:name> <maml:description> <maml:para>Specifies when the values should be set and returns true if keys were set and false otherwise.</maml:para> <maml:para>Values : Always, Exists, NotExists</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>with SetAndGet</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para>with When</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-RedisKey</command:name> <maml:description> <maml:para>Gets the key type or other details.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>RedisKey</command:noun> </command:details> <maml:description> <maml:para>Gets the key type or other details.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RedisKey</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RedisKey</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>TimeToLive</maml:name> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <maml:description> <maml:para>Specifies the Redis key.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>TimeToLive</maml:name> <maml:description> <maml:para>Tells to get the time to live.</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>StackExchange.Redis.RedisType</maml:name> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.TimeSpan</maml:name> </dev:type> <maml:description> <maml:para>with TimeToLive</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-RedisKey</command:name> <maml:description> <maml:para>Sets the specified key properties.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>RedisKey</command:noun> </command:details> <maml:description> <maml:para>Sets the specified key properties.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RedisKey</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>TimeToLive</maml:name> <command:parameterValue required="true">Nullable[TimeSpan]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <maml:description> <maml:para>Specifies the Redis key.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>TimeToLive</maml:name> <maml:description> <maml:para>Sets the specified time to live. Use null in order to persist the key.</maml:para> </maml:description> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Test-RedisKey</command:name> <maml:description> <maml:para>Checks if the specified key exists.</maml:para> </maml:description> <command:verb>Test</command:verb> <command:noun>RedisKey</command:noun> </command:details> <maml:description> <maml:para>This command tests the specified keys and gets the number of existing.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-RedisKey</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <maml:description> <maml:para>Specifies the Redis keys.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Int64</maml:name> </dev:type> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-RedisKey</command:name> <maml:description> <maml:para>Removes the specified keys.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>RedisKey</command:noun> </command:details> <maml:description> <maml:para>Removes the specified keys.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RedisKey</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Result</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <maml:description> <maml:para>Specifies the Redis keys.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Result</maml:name> <maml:description> <maml:para>Tells to get the number of removed keys.</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Int64</maml:name> </dev:type> <maml:description> <maml:para>with Result</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Rename-RedisKey</command:name> <maml:description> <maml:para>Renames the specified key.</maml:para> </maml:description> <command:verb>Rename</command:verb> <command:noun>RedisKey</command:noun> </command:details> <maml:description> <maml:para>Renames the specified key.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Rename-RedisKey</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1" > <maml:name>NewKey</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>When</maml:name> <command:parameterValue required="true">When</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <maml:description> <maml:para>Specifies the Redis key.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="1" > <maml:name>NewKey</maml:name> <maml:description> <maml:para>Specifies the new Redis key.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>When</maml:name> <maml:description> <maml:para>Specifies when the key should be renamed and returns true if the key was renamed and false otherwise.</maml:para> <maml:para>Values : Always, Exists, NotExists</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para>with When</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Search-RedisKey</command:name> <maml:description> <maml:para>Searches for keys matching the pattern.</maml:para> </maml:description> <command:verb>Search</command:verb> <command:noun>RedisKey</command:noun> </command:details> <maml:description> <maml:para>Searches for keys matching the pattern.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Search-RedisKey</maml:name> <command:parameter required="false" position="0" > <maml:name>Pattern</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0" > <maml:name>Pattern</maml:name> <maml:description> <maml:para>Specifies the search pattern in one of two forms. (1) Without `[` and `]`, treated as simple pattern with `*` and `?` as wildcard characters and all other characters as literal. (2) With `[` or `]`, treated as glob-style pattern with `*`, `?`, `[]`, `[^]` and character `\` used for escaping literal characters.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-RedisHandler</command:name> <maml:description> <maml:para>Subscribes to the channel messages.</maml:para> </maml:description> <command:verb>Add</command:verb> <command:noun>RedisHandler</command:noun> </command:details> <maml:description> <maml:para>This command adds the handler of the channel messages and returns the object that may be used for removing this handler.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-RedisHandler</maml:name> <command:parameter required="true" position="0" > <maml:name>Channel</maml:name> <command:parameterValue required="true">RedisChannel</command:parameterValue> </command:parameter> <command:parameter required="true" position="1" > <maml:name>Handler</maml:name> <command:parameterValue required="true">ScriptBlock</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Channel</maml:name> <maml:description> <maml:para>Specifies the Redis channel.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="1" > <maml:name>Handler</maml:name> <maml:description> <maml:para>The channel message handler script. The script is invoked with two arguments: the channel and string message.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para>Use this object for Remove-RedisHandler.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$handler = Add-RedisHandler test { param($channel, $message) Write-Host "Channel $channel received: $message" } $null = $db.Publish('test', 'Hello') Remove-RedisHandler test $handler</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Send-RedisMessage</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RedisHandler</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Send-RedisMessage</command:name> <maml:description> <maml:para>Posts a message to the given channel.</maml:para> </maml:description> <command:verb>Send</command:verb> <command:noun>RedisMessage</command:noun> </command:details> <maml:description> <maml:para>Posts a message to the given channel.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-RedisMessage</maml:name> <command:parameter required="true" position="0" > <maml:name>Channel</maml:name> <command:parameterValue required="true">RedisChannel</command:parameterValue> </command:parameter> <command:parameter required="true" position="1" > <maml:name>Message</maml:name> <command:parameterValue required="true">RedisValue</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Result</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Channel</maml:name> <maml:description> <maml:para>Specifies the Redis channel.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="1" > <maml:name>Message</maml:name> <maml:description> <maml:para>Specifies the message to post.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Result</maml:name> <maml:description> <maml:para>Tells to return the number of clients that the message was sent to. In a Redis cluster, only clients connected to the same node as the publishing client are included.</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Int64</maml:name> </dev:type> <maml:description> <maml:para>with Result</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-RedisHandler</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RedisHandler</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-RedisHandler</command:name> <maml:description> <maml:para>Unsubscribes from the specified channel.</maml:para> </maml:description> <command:verb>Remove</command:verb> <command:noun>RedisHandler</command:noun> </command:details> <maml:description> <maml:para>This command removes the handler or all handlers from the specified channel.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RedisHandler</maml:name> <command:parameter required="true" position="0" > <maml:name>Channel</maml:name> <command:parameterValue required="true">RedisChannel</command:parameterValue> </command:parameter> <command:parameter required="false" position="1" > <maml:name>Handler</maml:name> <command:parameterValue required="true">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Channel</maml:name> <maml:description> <maml:para>Specifies the Redis channel.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="1" > <maml:name>Handler</maml:name> <maml:description> <maml:para>The object from Add-RedisHandler identifying the handler. If it is omitted then all handlers of the specified channel are unregistered.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> </command:parameters> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-RedisHandler</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Send-RedisMessage</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-RedisClixml</command:name> <maml:description> <maml:para>Restores an object from CLIXML string.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>RedisClixml</command:noun> </command:details> <maml:description> <maml:para>Restores an object from CLIXML string.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RedisClixml</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <maml:description> <maml:para>Specifies the Redis key.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-RedisClixml</command:name> <maml:description> <maml:para>Stores an object as CLIXML string.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>RedisClixml</command:noun> </command:details> <maml:description> <maml:para>Stores an object as CLIXML string.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RedisClixml</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1" > <maml:name>Value</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Depth</maml:name> <command:parameterValue required="true">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>TimeToLive</maml:name> <command:parameterValue required="true">Nullable[TimeSpan]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <maml:description> <maml:para>Specifies the Redis key.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="1" > <maml:name>Value</maml:name> <maml:description> <maml:para>Specifies the object to be serialized and stored as CLIXML string.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Depth</maml:name> <maml:description> <maml:para>Specifies how many levels of contained objects are included in the XML representation. Default: 1.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>TimeToLive</maml:name> <maml:description> <maml:para>Specifies the time to live.</maml:para> </maml:description> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Wait-RedisString</command:name> <maml:description> <maml:para>Waits for the string to exist and returns it.</maml:para> </maml:description> <command:verb>Wait</command:verb> <command:noun>RedisString</command:noun> </command:details> <maml:description> <maml:para>This command periodically checks the specified string and returns its value as soon as it exists. When the time is out, it returns nothing.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Wait-RedisString</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1" > <maml:name>Delay</maml:name> <command:parameterValue required="true">TimeSpan</command:parameterValue> </command:parameter> <command:parameter required="true" position="2" > <maml:name>Timeout</maml:name> <command:parameterValue required="true">TimeSpan</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <maml:description> <maml:para>Specifies the Redis key.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="1" > <maml:name>Delay</maml:name> <maml:description> <maml:para>Time to sleep between checks.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="2" > <maml:name>Timeout</maml:name> <maml:description> <maml:para>Total time to wait.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>none</maml:name> </dev:type> <maml:description> <maml:para>The time is out.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>The existing string.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Export-Redis</command:name> <maml:description> <maml:para>Exports data to JSON.</maml:para> </maml:description> <command:verb>Export</command:verb> <command:noun>Redis</command:noun> </command:details> <maml:description> <maml:para>By default, only persistent keys are exported. Use the parameter TimeToLive in order to include appropriate expiring keys. Use Import-Redis in order to import exported data.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-Redis</maml:name> <command:parameter required="true" position="0" > <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="1" > <maml:name>Pattern</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Exclude</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>TimeToLive</maml:name> <command:parameterValue required="true">Nullable[TimeSpan]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the output file.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="1" > <maml:name>Pattern</maml:name> <maml:description> <maml:para>Specifies the optional key pattern.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Exclude</maml:name> <maml:description> <maml:para>Tells to exclude keys matching the specified wildcard patterns.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>TimeToLive</maml:name> <maml:description> <maml:para>Tells to include expiring keys with their remaining time to live greater than the specified span.</maml:para> </maml:description> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Import-Redis</command:name> <maml:description> <maml:para>Imports data from JSON.</maml:para> </maml:description> <command:verb>Import</command:verb> <command:noun>Redis</command:noun> </command:details> <maml:description> <maml:para>This command imports keys from the file created by Export-Redis.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-Redis</maml:name> <command:parameter required="false" position="0" > <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0" > <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the input file.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Merge-RedisSet</command:name> <maml:description> <maml:para>Combines the specified sets.</maml:para> </maml:description> <command:verb>Merge</command:verb> <command:noun>RedisSet</command:noun> </command:details> <maml:description> <maml:para>This command performs Union, Intersect, Difference operations with the given source sets. Use the switch Destination in order to store results as the new set.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Merge-RedisSet</maml:name> <command:parameter required="true" position="0" > <maml:name>Operation</maml:name> <command:parameterValue required="true">SetOperation</command:parameterValue> </command:parameter> <command:parameter required="true" position="1" > <maml:name>Source</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Merge-RedisSet</maml:name> <command:parameter required="true" position="0" > <maml:name>Operation</maml:name> <command:parameterValue required="true">SetOperation</command:parameterValue> </command:parameter> <command:parameter required="true" position="1" > <maml:name>Source</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Destination</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Result</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Operation</maml:name> <maml:description> <maml:para>Specifies one of the set operations: Union Returns the members of the set resulting from the union of all the given sets. Intersect Returns the members of the set resulting from the intersection of all the given sets. Difference Returns the members of the set resulting from the difference between the first set and all the successive sets. Keys that do not exist are treated as empty sets.</maml:para> <maml:para>Values : Union, Intersect, Difference</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="1" > <maml:name>Source</maml:name> <maml:description> <maml:para>Specifies the source set keys. Keys that do not exist are treated as empty sets.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Destination</maml:name> <maml:description> <maml:para>Tells to store the result as the specified set. If the destination key exists, it is overwritten.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Result</maml:name> <maml:description> <maml:para>With Destination, tells to return the result number of elements.</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Int64</maml:name> </dev:type> <maml:description> <maml:para>with Destination + Result</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-RedisTransaction</command:name> <maml:description> <maml:para>Creates a transaction builder.</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>RedisTransaction</command:noun> </command:details> <maml:description> <maml:para>Use this cmdlet together with Invoke-RedisTransaction in order to avoid some known PowerShell pitfalls.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-RedisTransaction</maml:name> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>StackExchange.Redis.ITransaction</maml:name> </dev:type> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-RedisTransaction</command:name> <maml:description> <maml:para>Executes the transaction.</maml:para> </maml:description> <command:verb>Invoke</command:verb> <command:noun>RedisTransaction</command:noun> </command:details> <maml:description> <maml:para>This command executes the transaction and returns true if the transaction was committed and false otherwise. Use this cmdlet in order to avoid some known PowerShell pitfalls.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-RedisTransaction</maml:name> <command:parameter required="true" position="0" > <maml:name>Transaction</maml:name> <command:parameterValue required="true">ITransaction</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Transaction</maml:name> <maml:description> <maml:para>Specifies the transaction builder, for example from New-RedisTransaction.</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Use-RedisLock</command:name> <maml:description> <maml:para>Invokes the script with the lock.</maml:para> </maml:description> <command:verb>Use</command:verb> <command:noun>RedisLock</command:noun> </command:details> <maml:description> <maml:para>This command attempts taking the lock for the specified key and time. If the lock is taken then the script is invoked, otherwise the command fails. When the script completes, successfully or not, the lock is released. The lock expiry is extended automatically during the script work. The parameter Timeout is used as the estimated initial expiry.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Use-RedisLock</maml:name> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" position="1" > <maml:name>Script</maml:name> <command:parameterValue required="true">ScriptBlock</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Delay</maml:name> <command:parameterValue required="true">TimeSpan</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Timeout</maml:name> <command:parameterValue required="true">TimeSpan</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Value</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Key</maml:name> <maml:description> <maml:para>Specifies the Redis key.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="1" > <maml:name>Script</maml:name> <maml:description> <maml:para>Specifies the script block invoked with the lock.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Delay</maml:name> <maml:description> <maml:para>Time to sleep between the lock taking attempts. Default: 1 second</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Timeout</maml:name> <maml:description> <maml:para>Total time for the lock taking attempts. Default: 1 minute</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Value</maml:name> <maml:description> <maml:para>The optional lock value. Default: 16 generated bytes</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para>Script output, if any</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-RedisScript</command:name> <maml:description> <maml:para>Executes Lua scripts against the server.</maml:para> </maml:description> <command:verb>Invoke</command:verb> <command:noun>RedisScript</command:noun> </command:details> <maml:description> <maml:para>This command executes the script against the server and returns the result.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-RedisScript</maml:name> <command:parameter required="true" position="0" > <maml:name>Script</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Argv</maml:name> <command:parameterValue required="true">RedisValue[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Keys</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-RedisScript</maml:name> <command:parameter required="true" position="named" > <maml:name>LuaScript</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <command:parameterValue required="true">IDatabase</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Parameters</maml:name> <command:parameterValue required="true">Object</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Script</maml:name> <maml:description> <maml:para>The normal Lua script to execute. Normal Lua scripts use KEYS and ARGV arrays of keys and values provided by the parameters Keys and Argv.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Argv</maml:name> <maml:description> <maml:para>Provides the values referenced by Script as ARGV[1], ARGV[2], ...</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database, usually returned by Open-Redis. When omitted, the variable $db is used if it exists, otherwise the default database is used if it is defined as $env:FARNET_REDIS_CONFIGURATION</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Keys</maml:name> <maml:description> <maml:para>Provides the keys referenced by Script as KEYS[1], KEYS[2], ...</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>LuaScript</maml:name> <maml:description> <maml:para>The prepared Lua script to execute, either string (to be prepared) or StackExchange.Redis.LuaScript (already prepared). Prepared scripts use @name parameter notation instead of KEYS and ARGV. Values are provided by the parameter Parameters properties and fields.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Parameters</maml:name> <maml:description> <maml:para>An object with properties or fields referenced by LuaScript. All parameters referenced by the script must be available.</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>StackExchange.Redis.RedisResult</maml:name> </dev:type> </command:returnValue> </command:returnValues> </command:command> </helpItems> |