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: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>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: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: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>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: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: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: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: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: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: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>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="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 fields.</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-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="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-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>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-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>Decrement</maml:name> <maml:description> <maml:para>Decrements by the specified number and gets the result integer.</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 number and gets the result integer.</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.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.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 one or more 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 one or more 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>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>Register-RedisSub</command:name> <maml:description> <maml:para>Registers the channel message handler.</maml:para> </maml:description> <command:verb>Register</command:verb> <command:noun>RedisSub</command:noun> </command:details> <maml:description> <maml:para>This command registers the specified channel handler.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Register-RedisSub</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>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: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>Script</maml:name> <maml:description> <maml:para>The channel message handler script. The script is invoked with two arguments: the channel and the received 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 Unregister-RedisSub.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$handler = Register-RedisSub test { param($channel, $message) Write-Host "Channel $channel received: $message" } $null = $db.Publish('test', 'Hello') Unregister-RedisSub test $handler</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Unregister-RedisSub</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>Unregister-RedisSub</command:name> <maml:description> <maml:para>Unregisters the channel subscription handler.</maml:para> </maml:description> <command:verb>Unregister</command:verb> <command:noun>RedisSub</command:noun> </command:details> <maml:description> <maml:para>This command unregisters the specified channel handler or all handlers of the specified channel.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Unregister-RedisSub</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 Register-RedisSub 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>Register-RedisSub</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>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>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> </helpItems> |