How to set the key name in target

Author: ilianiliev-redis

content/integrate/redis-data-integration/data-pipelines/transform-examples/redis-set-key-name.md

@@ -0,0 +1,62 @@
+---
+Title: Set the key name in target database
+aliases: /integrate/redis-data-integration/ingest/data-pipelines/transform-examples/redis-set-key/
+alwaysopen: false
+categories:
+- docs
+- integrate
+- rs
+- rdi
+description: null
+group: di
+linkTitle: Set the key name in target database
+summary: Redis Data Integration keeps Redis in sync with the primary database in near
+  real time.
+type: integration
+weight: 30
+---
+
+The default key is a combination of the table name, the name of the primary key and the value of the primary key. For example, if the table name is `employee` and the primary key is `employeeid`, the key name will be `employee:employeeid:1` for the record with `employeeid` equal to 1.
+
+When using composite primary keys, the key name will be a combination of the table name, the name of the primary keys and the values of the primary keys. For example, if the table name is `orders` and the primary keys are `orderid` and `customerid`, the key name will be `orders:orderid:1:customerid:2` for the record with `orderid` equal to 1 and `customerid` equal to 2.
+
+
+If you want to set the key manually you can use the `redis.write` section in the `output` section of the job file. The `key` section allows you to specify a custom key format using the `expression` and `language` parameters. The `expression` parameter allows you to specify a custom key format using the `jmespath` or `sql` language. The `language` parameter allows you to specify the language used in the `expression` parameter. Example:
+
+
+```yaml
+source:
+  server_name: rdi
+  db: inventory
+  table: customers
+output:
+  - uses: redis.write
+    with:
+      data_type: hash
+      key:
+        expression: concat(['customers', '#', id])
+        language: jmespath
+```
+
+--- 
+
+{{<note>}}
+When using the full row format it is important to reference the attributes you use for building the key name correctly to support both create/update and delete operations. Example:
+
+```yaml
+source:
+server_name: rdi
+db: inventory
+table: customers
+row_format: full
+output:
+- uses: redis.write
+  with:
+  data_type: hash
+  key:
+  # Here we use the operation code to determine the value of the key to ensure that
+  # delete operations will result in the correct key being deleted
+  expression: concat(['customers', '#', opcode == 'd' && before.id || after.id])
+  language: jmespath
+```
+{{</note>}}