Class RedisDestination<TInput>
A data flow destination for Redis. Regis is a key/value store.
You can define a key column using either a KeyColumnAttribute on your object or assign a value
to the KeyColumn property. If no key column is provided, a Guid is created and used as key.
The stored value will contain your serialized object using Newtonsoft.Json and JsonConvert.
Inheritance
RedisDestination<TInput>
Namespace: ETLBox.Redis
Assembly: ETLBox.Redis.dll
Syntax
{{< /rawhtml >}}
```C#
public class RedisDestination : DataFlowBatchDestination, IDataFlowBatchDestination, IDataFlowDestination, IDataFlowBatchDestination, IDataFlowDestination, IDataFlowComponent, ILoggableTask
```
{{< rawhtml >}}
Type Parameters
| Name |
Description |
| TInput |
Type of ingoing data.
|
Constructors
RedisDestination()
Declaration
{{< /rawhtml >}}
```C#
public RedisDestination()
```
{{< rawhtml >}}
RedisDestination(int)
Declaration
{{< /rawhtml >}}
```C#
public RedisDestination(int batchSize)
```
{{< rawhtml >}}
Parameters
| Type |
Name |
Description |
| int |
batchSize |
|
Properties
ConnectionString
If you provide a connection string, this component will create a new ConnectionMultiplexer object
to connect with redis. If you already have a connection object instantiated in your application,
use RedisConnection instead to pass it to the component.
Declaration
{{< /rawhtml >}}
```C#
public string ConnectionString { get; set; }
```
{{< rawhtml >}}
Property Value
DatabaseNumber
Use the database number to store your data (redis databases are numbered from 0 to 15)
The default database is 0.
Declaration
{{< /rawhtml >}}
```C#
public int DatabaseNumber { get; set; }
```
{{< rawhtml >}}
Property Value
KeyColumn
Define the property in your dynamic or strongly type object that is used for retrieving the key
value. The property must be either of type string or implement the ToString() method.
Only one property can be used as key.
You can also use the KeyColumn attribute instead.
Declaration
{{< /rawhtml >}}
```C#
public KeyColumn KeyColumn { get; set; }
```
{{< rawhtml >}}
Property Value
RedisConnection
An existing ConnectionMultiplexer that holds a redis connection.
Declaration
{{< /rawhtml >}}
```C#
public ConnectionMultiplexer RedisConnection { get; set; }
```
{{< rawhtml >}}
Property Value
| Type |
Description |
| ConnectionMultiplexer |
|
SerializationFunc
By default, your object is serialzed into json. Define your own serialization function
here.
Declaration
{{< /rawhtml >}}
```C#
public Func SerializationFunc { get; set; }
```
{{< rawhtml >}}
Property Value
SerializerSettings
The JsonSerializerSettings used to serialize or deserialize your object into json.
By default, your object is serialized into json. Use SerializationFunc if you want
to define your own serialization function.
Declaration
{{< /rawhtml >}}
```C#
public JsonSerializerSettings SerializerSettings { get; set; }
```
{{< rawhtml >}}
Property Value
| Type |
Description |
| JsonSerializerSettings |
|
SetParameter
Provide additional redis parameter that are used when setting the key/value pairs in redis.
Declaration
{{< /rawhtml >}}
```C#
public RedisDestination.RedisSetParameter SetParameter { get; set; }
```
{{< rawhtml >}}
Property Value
Methods
BulkInsertData(TInput[])
Declaration
{{< /rawhtml >}}
```C#
protected override void BulkInsertData(TInput[] data)
```
{{< rawhtml >}}
Parameters
| Type |
Name |
Description |
| TInput[] |
data |
|
Overrides
CheckParameter()
Declaration
{{< /rawhtml >}}
```C#
protected override void CheckParameter()
```
{{< rawhtml >}}
Overrides
FinishWrite()
Declaration
{{< /rawhtml >}}
```C#
protected override void FinishWrite()
```
{{< rawhtml >}}
Overrides
InitCheckedParameter()
Declaration
{{< /rawhtml >}}
```C#
protected override void InitCheckedParameter()
```
{{< rawhtml >}}
Overrides
PrepareParameterForCheck()
Declaration
{{< /rawhtml >}}
```C#
protected override void PrepareParameterForCheck()
```
{{< rawhtml >}}
Overrides
PrepareWrite()
Declaration
{{< /rawhtml >}}
```C#
protected override void PrepareWrite()
```
{{< rawhtml >}}
Overrides
Implements
{{< /rawhtml >}}