DOC-3933: final 8 tabbed code examples (#2784)

2025-08-06 02:15:48 +03:00 · 2024-07-03 12:29:13 -07:00
parent e7347f8a51
commit 0f3d0f3d1f
8 changed files with 543 additions and 0 deletions
--- a/doctests/dt-bitfield.js
+++ b/doctests/dt-bitfield.js
@@ -0,0 +1,76 @@
+// EXAMPLE: bitfield_tutorial
+// HIDE_START
+import assert from 'assert';
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+// HIDE_END
+
+// REMOVE_START
+await client.flushDb();
+// REMOVE_END
+
+// STEP_START bf
+let res1 = await client.bitField("bike:1:stats", [{
+  operation: 'SET',
+  encoding: 'u32',
+  offset: '#0',
+  value: 1000
+}]);
+console.log(res1);  // >>> [0]
+
+let res2 = await client.bitField('bike:1:stats', [
+  {
+    operation: 'INCRBY',
+    encoding: 'u32',
+    offset: '#0',
+    increment: -50
+  },
+  {
+    operation: 'INCRBY',
+    encoding: 'u32',
+    offset: '#1',
+    increment: 1
+  }
+]);
+console.log(res2);  // >>> [950, 1]
+
+let res3 = await client.bitField('bike:1:stats', [
+  {
+    operation: 'INCRBY',
+    encoding: 'u32',
+    offset: '#0',
+    increment: 500
+  },
+  {
+    operation: 'INCRBY',
+    encoding: 'u32',
+    offset: '#1',
+    increment: 1
+  }
+]);
+console.log(res3);  // >>> [1450, 2]
+
+let res4 = await client.bitField('bike:1:stats', [
+  {
+    operation: 'GET',
+    encoding: 'u32',
+    offset: '#0'
+  },
+  {
+    operation: 'GET',
+    encoding: 'u32',
+    offset: '#1'
+  }
+]);
+console.log(res4);  // >>> [1450, 2]
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res1, [0])
+assert.deepEqual(res2, [950, 1])
+assert.deepEqual(res3, [1450, 2])
+assert.deepEqual(res4, [1450, 2])
+await client.quit();
+// REMOVE_END
--- a/doctests/dt-bloom.js
+++ b/doctests/dt-bloom.js
@@ -0,0 +1,46 @@
+// EXAMPLE: bf_tutorial
+// HIDE_START
+import assert from 'assert';
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+// HIDE_END
+
+// REMOVE_START
+await client.flushDb();
+// REMOVE_END
+
+// STEP_START bloom
+const res1 = await client.bf.reserve('bikes:models', 0.01, 1000);
+console.log(res1);  // >>> OK
+
+const res2 = await client.bf.add('bikes:models', 'Smoky Mountain Striker');
+console.log(res2);  // >>> true
+
+const res3 = await client.bf.exists('bikes:models', 'Smoky Mountain Striker');
+console.log(res3);  // >>> true
+
+const res4 = await client.bf.mAdd('bikes:models', [
+  'Rocky Mountain Racer',
+  'Cloudy City Cruiser',
+  'Windy City Wippet'
+]);
+console.log(res4);  // >>> [true, true, true]
+
+const res5 = await client.bf.mExists('bikes:models', [
+  'Rocky Mountain Racer',
+  'Cloudy City Cruiser',
+  'Windy City Wippet'
+]);
+console.log(res5);  // >>> [true, true, true]
+// STEP_END
+
+// REMOVE_START
+assert.equal(res1, 'OK')
+assert.equal(res2, true)
+assert.equal(res3, true)
+assert.deepEqual(res4, [true, true, true])
+assert.deepEqual(res5, [true, true, true])
+await client.quit();
+// REMOVE_END
--- a/doctests/dt-cms.js
+++ b/doctests/dt-cms.js
@@ -0,0 +1,50 @@
+// EXAMPLE: cms_tutorial
+// HIDE_START
+import assert from 'assert';
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+// HIDE_END
+
+// REMOVE_START
+await client.flushDb();
+// REMOVE_END
+
+// STEP_START cms
+const res1 = await client.cms.initByProb('bikes:profit', 0.001, 0.002);
+console.log(res1);  // >>> OK
+
+const res2 = await client.cms.incrBy('bikes:profit', {
+    item: 'Smoky Mountain Striker',
+    incrementBy: 100
+});
+console.log(res2);  // >>> [100]
+
+const res3 = await client.cms.incrBy('bikes:profit', [
+  {
+    item: 'Rocky Mountain Racer',
+    incrementBy: 200
+  },
+  {
+    item: 'Cloudy City Cruiser',
+    incrementBy: 150
+  }
+]);
+console.log(res3);  // >>> [200, 150]
+
+const res4 = await client.cms.query('bikes:profit', 'Smoky Mountain Striker');
+console.log(res4);  // >>> [100]
+
+const res5 = await client.cms.info('bikes:profit');
+console.log(res5.width, res5.depth, res5.count);  // >>> 2000 9 450
+// STEP_END
+
+// REMOVE_START
+assert.equal(res1, 'OK')
+assert.deepEqual(res2, [100])
+assert.deepEqual(res3, [200, 150])
+assert.deepEqual(res4, [100])
+assert.deepEqual(res5, { width: 2000, depth: 9, count: 450 })
+await client.quit();
+// REMOVE_END
--- a/doctests/dt-cuckoo.js
+++ b/doctests/dt-cuckoo.js
@@ -0,0 +1,38 @@
+// EXAMPLE: cuckoo_tutorial
+// HIDE_START
+import assert from 'assert';
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+// HIDE_END
+
+// REMOVE_START
+await client.flushDb();
+// REMOVE_END
+
+// STEP_START cuckoo
+const res1 = await client.cf.reserve('bikes:models', 1000000);
+console.log(res1);  // >>> OK
+
+const res2 = await client.cf.add('bikes:models', 'Smoky Mountain Striker');
+console.log(res2);  // >>> 1
+
+const res3 = await client.cf.exists('bikes:models', 'Smoky Mountain Striker');
+console.log(res3);  // >>> 1
+
+const res4 = await client.cf.exists('bikes:models', 'Terrible Bike Name');
+console.log(res4);  // >>> 0
+
+const res5 = await client.cf.del('bikes:models', 'Smoky Mountain Striker');
+console.log(res5);  // >>> 1
+// STEP_END
+
+// REMOVE_START
+assert.equal(res1, 'OK')
+assert.equal(res2, true)
+assert.equal(res3, true)
+assert.equal(res4, false)
+assert.equal(res5, true)
+await client.quit();
+// REMOVE_END
--- a/doctests/dt-hll.js
+++ b/doctests/dt-hll.js
@@ -0,0 +1,38 @@
+// EXAMPLE: hll_tutorial
+// HIDE_START
+import assert from 'assert';
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+// HIDE_END
+
+// REMOVE_START
+await client.flushDb();
+// REMOVE_END
+
+// STEP_START pfadd
+const res1 = await client.pfAdd('bikes', ['Hyperion', 'Deimos', 'Phoebe', 'Quaoar']);
+console.log(res1);  // >>> true
+
+const res2 = await client.pfCount('bikes');
+console.log(res2);  // >>> 4
+
+const res3 = await client.pfAdd('commuter_bikes', ['Salacia', 'Mimas', 'Quaoar']);
+console.log(res3);  // >>> true
+
+const res4 = await client.pfMerge('all_bikes', ['bikes', 'commuter_bikes']);
+console.log(res4);  // >>> OK
+
+const res5 = await client.pfCount('all_bikes');
+console.log(res5);  // >>> 6
+// STEP_END
+
+// REMOVE_START
+assert.equal(res1, true)
+assert.equal(res2, 4)
+assert.equal(res3, true)
+assert.equal(res4, 'OK')
+assert.equal(res5, 6)
+await client.quit();
+// REMOVE_END
--- a/doctests/dt-ss.js
+++ b/doctests/dt-ss.js
@@ -0,0 +1,162 @@
+// EXAMPLE: ss_tutorial
+// HIDE_START
+import assert from 'assert';
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+// HIDE_END
+
+// REMOVE_START
+await client.flushDb();
+// REMOVE_END
+
+// STEP_START zadd
+const res1 = await client.zAdd('racer_scores', { score: 10, value: 'Norem' });
+console.log(res1);  // >>> 1
+
+const res2 = await client.zAdd('racer_scores', { score: 12, value: 'Castilla' });
+console.log(res2);  // >>> 1
+
+const res3 = await client.zAdd('racer_scores', [
+  { score: 8, value: 'Sam-Bodden' },
+  { score: 10, value: 'Royce' },
+  { score: 6, value: 'Ford' },
+  { score: 14, value: 'Prickett' },
+  { score: 12, value: 'Castilla' }
+]);
+console.log(res3);  // >>> 4
+// STEP_END
+
+// REMOVE_START
+assert.equal(res1, 1)
+assert.equal(res2, 1)
+assert.equal(res3, 4)
+// REMOVE_END
+
+// REMOVE_START
+const count = await client.zCard('racer_scores');
+console.assert(count === 6);
+// REMOVE_END
+
+// STEP_START zrange
+const res4 = await client.zRange('racer_scores', 0, -1);
+console.log(res4);  // >>> ['Ford', 'Sam-Bodden', 'Norem', 'Royce', 'Castilla', 'Prickett']
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res4, ['Ford', 'Sam-Bodden', 'Norem', 'Royce', 'Castilla', 'Prickett'])
+// REMOVE_END
+
+// STEP_START zrange_withscores
+const res6 = await client.zRangeWithScores('racer_scores', 0, -1);
+console.log(res6);
+// >>> [
+//       { value: 'Ford', score: 6 }, { value: 'Sam-Bodden', score: 8 },
+//       { value: 'Norem', score: 10 }, { value: 'Royce', score: 10 },
+//       { value: 'Castilla', score: 12 }, { value: 'Prickett', score: 14 }
+// ]
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res6, [ { value: 'Ford', score: 6 }, { value: 'Sam-Bodden', score: 8 }, { value: 'Norem', score: 10 }, { value: 'Royce', score: 10 }, { value: 'Castilla', score: 12 }, { value: 'Prickett', score: 14 } ]
+)
+// REMOVE_END
+
+// STEP_START zrangebyscore
+const res7 = await client.zRangeByScore('racer_scores', '-inf', 10);
+console.log(res7);  // >>> ['Ford', 'Sam-Bodden', 'Norem', 'Royce']
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res7, ['Ford', 'Sam-Bodden', 'Norem', 'Royce'])
+// REMOVE_END
+
+// STEP_START zremrangebyscore
+const res8 = await client.zRem('racer_scores', 'Castilla');
+console.log(res8);  // >>> 1
+
+const res9 = await client.zRemRangeByScore('racer_scores', '-inf', 9);
+console.log(res9);  // >>> 2
+
+// REMOVE_START
+assert.equal(res8, 1)
+assert.equal(res9, 2)
+// REMOVE_END
+
+const res10 = await client.zRange('racer_scores', 0, -1);
+console.log(res10);  // >>> ['Norem', 'Royce', 'Prickett']
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res10, ['Norem', 'Royce', 'Prickett'])
+// REMOVE_END
+
+// REMOVE_START
+const count2 = await client.zCard('racer_scores');
+console.assert(count2 === 3);
+// REMOVE_END
+
+// STEP_START zrank
+const res11 = await client.zRank('racer_scores', 'Norem');
+console.log(res11);  // >>> 0
+
+const res12 = await client.zRevRank('racer_scores', 'Norem');
+console.log(res12);  // >>> 2
+// STEP_END
+
+// STEP_START zadd_lex
+const res13 = await client.zAdd('racer_scores', [
+  { score: 0, value: 'Norem' },
+  { score: 0, value: 'Sam-Bodden' },
+  { score: 0, value: 'Royce' },
+  { score: 0, value: 'Ford' },
+  { score: 0, value: 'Prickett' },
+  { score: 0, value: 'Castilla' }
+]);
+console.log(res13);  // >>> 3
+
+// REMOVE_START
+assert.equal(count2, 3)
+assert.equal(res11, 0)
+assert.equal(res12, 2)
+assert.equal(res13, 3)
+// REMOVE_END
+
+const res14 = await client.zRange('racer_scores', 0, -1);
+console.log(res14);  // >>> ['Castilla', 'Ford', 'Norem', 'Prickett', 'Royce', 'Sam-Bodden']
+
+const res15 = await client.zRangeByLex('racer_scores', '[A', '[L');
+console.log(res15);  // >>> ['Castilla', 'Ford']
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res14, ['Castilla', 'Ford', 'Norem', 'Prickett', 'Royce', 'Sam-Bodden'])
+assert.deepEqual(res15, ['Castilla', 'Ford'])
+// REMOVE_END
+
+// STEP_START leaderboard
+const res16 = await client.zAdd('racer_scores', { score: 100, value: 'Wood' });
+console.log(res16);  // >>> 1
+
+const res17 = await client.zAdd('racer_scores', { score: 100, value: 'Henshaw' });
+console.log(res17);  // >>> 1
+
+const res18 = await client.zAdd('racer_scores', { score: 150, value: 'Henshaw' }, { nx: true });
+console.log(res18);  // >>> 0
+
+const res19 = await client.zIncrBy('racer_scores', 50, 'Wood');
+console.log(res19);  // >>> 150.0
+
+const res20 = await client.zIncrBy('racer_scores', 50, 'Henshaw');
+console.log(res20);  // >>> 200.0
+// STEP_END
+
+// REMOVE_START
+assert.equal(res16, 1)
+assert.equal(res17, 1)
+assert.equal(res18, 0)
+assert.equal(res19, 150.0)
+assert.equal(res20, 200.0)
+await client.quit();
+// REMOVE_END
--- a/doctests/dt-tdigest.js
+++ b/doctests/dt-tdigest.js
@@ -0,0 +1,85 @@
+// EXAMPLE: tdigest_tutorial
+// HIDE_START
+import assert from 'assert';
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+// HIDE_END
+
+// REMOVE_START
+await client.flushDb();
+// REMOVE_END
+
+// STEP_START tdig_start
+const res1 = await client.tDigest.create('bikes:sales', 100);
+console.log(res1);  // >>> OK
+
+const res2 = await client.tDigest.add('bikes:sales', [21]);
+console.log(res2);  // >>> OK
+
+const res3 = await client.tDigest.add('bikes:sales', [150, 95, 75, 34]);
+console.log(res3);  // >>> OK
+// STEP_END
+
+// REMOVE_START
+assert.equal(res1, 'OK')
+assert.equal(res2, 'OK')
+assert.equal(res3, 'OK')
+// REMOVE_END
+
+// STEP_START tdig_cdf
+const res4 = await client.tDigest.create('racer_ages');
+console.log(res4);  // >>> OK
+
+const res5 = await client.tDigest.add('racer_ages', [
+  45.88, 44.2, 58.03, 19.76, 39.84, 69.28, 50.97, 25.41, 19.27, 85.71, 42.63
+]);
+console.log(res5);  // >>> OK
+
+const res6 = await client.tDigest.rank('racer_ages', [50]);
+console.log(res6);  // >>> [7]
+
+const res7 = await client.tDigest.rank('racer_ages', [50, 40]);
+console.log(res7);  // >>> [7, 4]
+// STEP_END
+
+// REMOVE_START
+assert.equal(res4, 'OK')
+assert.equal(res5, 'OK')
+assert.deepEqual(res6, [7])
+assert.deepEqual(res7, [7, 4])
+// REMOVE_END
+
+// STEP_START tdig_quant
+const res8 = await client.tDigest.quantile('racer_ages', [0.5]);
+console.log(res8);  // >>> [44.2]
+
+const res9 = await client.tDigest.byRank('racer_ages', [4]);
+console.log(res9);  // >>> [42.63]
+// STEP_END
+
+// STEP_START tdig_min
+const res10 = await client.tDigest.min('racer_ages');
+console.log(res10);  // >>> 19.27
+
+const res11 = await client.tDigest.max('racer_ages');
+console.log(res11);  // >>> 85.71
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res8, [44.2])
+assert.deepEqual(res9, [42.63])
+assert.equal(res10, 19.27)
+assert.equal(res11, 85.71)
+// REMOVE_END
+
+// STEP_START tdig_reset
+const res12 = await client.tDigest.reset('racer_ages');
+console.log(res12);  // >>> OK
+// STEP_END
+
+// REMOVE_START
+assert.equal(res12, 'OK')
+await client.quit();
+// REMOVE_END
--- a/doctests/dt-topk.js
+++ b/doctests/dt-topk.js
@@ -0,0 +1,48 @@
+// EXAMPLE: topk_tutorial
+// HIDE_START
+import assert from 'assert';
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+// HIDE_END
+
+// REMOVE_START
+await client.flushDb();
+// REMOVE_END
+
+// STEP_START topk
+const res1 = await client.topK.reserve('bikes:keywords', 5, {
+    width: 2000,
+    depth: 7,
+    decay: 0.925
+});
+console.log(res1);  // >>> OK
+
+const res2 = await client.topK.add('bikes:keywords', [
+  'store',
+  'seat',
+  'handlebars',
+  'handles',
+  'pedals',
+  'tires',
+  'store',
+  'seat'
+]);
+console.log(res2);  // >>> [null, null, null, null, null, 'handlebars', null, null]
+
+const res3 = await client.topK.list('bikes:keywords');
+console.log(res3);  // >>> ['store', 'seat', 'pedals', 'tires', 'handles']
+
+const res4 = await client.topK.query('bikes:keywords', ['store', 'handlebars']);
+console.log(res4);  // >>> [1, 0]
+// STEP_END
+
+// REMOVE_START
+assert.equal(res1, 'OK')
+assert.deepEqual(res2, [null, null, null, null, null, 'handlebars', null, null])
+assert.deepEqual(res3, ['store', 'seat', 'pedals', 'tires', 'handles'])
+assert.deepEqual(res4, [1, 0])
+await client.quit();
+// REMOVE_END
+