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.</maml:para> </maml:description> <command:syntax> <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: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: "localhost:3278" "localhost:3278,AllowAdmin=true"</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>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>The database from Open-Redis, the variable $db by default.</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>The database from Open-Redis, the variable $db by default.</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 cmdlet when the type is defined as a variable or unknown. In other cases use the 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>The database from Open-Redis, the variable $db by default.</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.Collections.Generic.List[System.String]</maml:name> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.HashSet[System.String]</maml:name> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.Dictionary[System.String, 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>Get-RedisHash</command:name> <maml:description> <maml:para>Gets the specified hash.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>RedisHash</command:noun> </command:details> <maml:description> <maml:para>Without extra parameters this cmdlet gets the hash.</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="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="true" position="named" > <maml:name>Count</maml:name> <maml:description> <maml:para>Tells to get 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>The database from Open-Redis, the variable $db by default.</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.Dictionary[System.String, System.String]</maml:name> </dev:type> </command:returnValue> <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>Get-RedisList</command:name> <maml:description> <maml:para>Gets the specified list.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>RedisList</command:noun> </command:details> <maml:description> <maml:para>Without extra parameters this cmdlet gets the list.</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: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>Tells to get 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>The database from Open-Redis, the variable $db by default.</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List[System.String]</maml:name> </dev:type> </command:returnValue> <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>Get-RedisSet</command:name> <maml:description> <maml:para>Gets the specified set.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>RedisSet</command:noun> </command:details> <maml:description> <maml:para>Without extra parameters this cmdlet gets the set.</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>Tells to get 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>The database from Open-Redis, the variable $db by default.</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.HashSet[System.String]</maml:name> </dev:type> </command:returnValue> <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>Get-RedisString</command:name> <maml:description> <maml:para>Gets the specified strings.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>RedisString</command:noun> </command:details> <maml:description> <maml:para>Without extra parameters this cmdlet gets strings.</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: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>The database from Open-Redis, the variable $db by default.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Length</maml:name> <maml:description> <maml:para>Tells to get the string length.</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> </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 the specified hash.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>RedisHash</command:noun> </command:details> <maml:description> <maml:para>Sets the specified 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>Value</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>Update</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 key.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="1" > <maml:name>Value</maml:name> <maml:description> <maml:para>The new hash.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>The database from Open-Redis, the variable $db by default.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Update</maml:name> <maml:description> <maml:para>Tells to update the hash if it exists.</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-RedisList</command:name> <maml:description> <maml:para>Sets the specified list.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>RedisList</command:noun> </command:details> <maml:description> <maml:para>Sets the specified 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>Value</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>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>Value</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>LeftPush</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>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>Value</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>RightPush</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="1" > <maml:name>Value</maml:name> <maml:description> <maml:para>The new list.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>The database from Open-Redis, the variable $db by default.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>LeftPush</maml:name> <maml:description> <maml:para>Tells to inserts new items at the start.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>RightPush</maml:name> <maml:description> <maml:para>Tells to append new items to the end.</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 the specified set.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>RedisSet</command:noun> </command:details> <maml:description> <maml:para>Sets the specified 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>Value</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>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>Value</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Add</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="1" > <maml:name>Value</maml:name> <maml:description> <maml:para>The new set.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Add</maml:name> <maml:description> <maml:para>Tells to add new items.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>The database from Open-Redis, the variable $db by default.</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 the specified string.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>RedisString</command:noun> </command:details> <maml:description> <maml:para>Sets the specified 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">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>Expiry</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="1" > <maml:name>Value</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Get</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:parameter required="false" position="named" > <maml:name>Expiry</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="1" > <maml:name>Value</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Append</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>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">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Decrement</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>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">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Increment</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>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">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" position="named" > <maml:name>When</maml:name> <command:parameterValue required="true">When</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="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>Tells to append if the string exists and get 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>The database from Open-Redis, the variable $db by default.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Decrement</maml:name> <maml:description> <maml:para>Decrements the number and gets the result number.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Expiry</maml:name> <maml:description> <maml:para>Tells to set the expiry time span.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Get</maml:name> <maml:description> <maml:para>Tells to atomically set the new string and return the old if any.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>Increment</maml:name> <maml:description> <maml:para>Increments the number and gets the result number.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" position="named" > <maml:name>When</maml:name> <maml:description> <maml:para>Specifies when the new value should be set and gets the result. The result is true or false if the value is set or not set. Values to use: Always or Exists.</maml:para> <maml:para>Values : Always, Exists, NotExists</maml:para> </maml:description> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>none</maml:name> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Int64</maml:name> </dev:type> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Double</maml:name> </dev:type> </command:returnValue> <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>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 for existence and returns its value or none if the time is out.</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>The database from Open-Redis, the variable $db by default.</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>Get-RedisKey</command:name> <maml:description> <maml:para>Gets the specified key information.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>RedisKey</command:noun> </command:details> <maml:description> <maml:para>Without extra parameters this cmdlet gets the value type.</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>The database from Open-Redis, the variable $db by default.</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 span.</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> </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>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>The database from Open-Redis, the variable $db by default.</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>The database from Open-Redis, the variable $db by default.</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>none</maml:name> </dev:type> </command:returnValue> <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>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.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Database</maml:name> <maml:description> <maml:para>The database from Open-Redis, the variable $db by default.</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>The database from Open-Redis, the variable $db by default.</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>The database from Open-Redis, the variable $db by default.</maml:para> </maml:description> </command:parameter> </command:parameters> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Register-RedisSub</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |