Skip to content

Commit 8459a3e

Browse files
committed
include link to batch methods
1 parent 6f8d257 commit 8459a3e

File tree

1 file changed

+47
-39
lines changed

1 file changed

+47
-39
lines changed

docs/sphinx/source/howto/exchange_data_with_app/exchange-data-with-app.ipynb

+47-39
Original file line numberDiff line numberDiff line change
@@ -271,40 +271,40 @@
271271
},
272272
{
273273
"cell_type": "markdown",
274-
"id": "vocal-titanium",
274+
"id": "sapphire-flower",
275275
"metadata": {},
276276
"source": [
277277
"## Get data"
278278
]
279279
},
280280
{
281281
"cell_type": "markdown",
282-
"id": "identical-disposal",
282+
"id": "mental-ancient",
283283
"metadata": {},
284284
"source": [
285285
"Similarly to the examples about feeding, we can get a batch of data for convenience or get individual data points for increased control."
286286
]
287287
},
288288
{
289289
"cell_type": "markdown",
290-
"id": "korean-recruitment",
290+
"id": "accessible-miniature",
291291
"metadata": {},
292292
"source": [
293293
"### Batch"
294294
]
295295
},
296296
{
297297
"cell_type": "markdown",
298-
"id": "french-vehicle",
298+
"id": "drawn-closure",
299299
"metadata": {},
300300
"source": [
301-
"We need to prepare the data as a list of dicts having the `id` key holding a unique id of the data point."
301+
"We need to prepare the data as a list of dicts having the `id` key holding a unique id of the data point. We then get the batch from the desired schema using the [get_batch](../../reference-api.rst#get-batch) method."
302302
]
303303
},
304304
{
305305
"cell_type": "code",
306306
"execution_count": 8,
307-
"id": "formal-dealing",
307+
"id": "growing-pioneer",
308308
"metadata": {},
309309
"outputs": [],
310310
"source": [
@@ -314,23 +314,23 @@
314314
},
315315
{
316316
"cell_type": "markdown",
317-
"id": "light-dividend",
317+
"id": "objective-apache",
318318
"metadata": {},
319319
"source": [
320320
"### Individual data points"
321321
]
322322
},
323323
{
324324
"cell_type": "markdown",
325-
"id": "sophisticated-forwarding",
325+
"id": "periodic-patient",
326326
"metadata": {},
327327
"source": [
328328
"We can get individual data points synchronously or asynchronously."
329329
]
330330
},
331331
{
332332
"cell_type": "markdown",
333-
"id": "drawn-cooper",
333+
"id": "thick-plaza",
334334
"metadata": {},
335335
"source": [
336336
"#### Synchronous"
@@ -339,7 +339,7 @@
339339
{
340340
"cell_type": "code",
341341
"execution_count": 9,
342-
"id": "isolated-murder",
342+
"id": "interpreted-warrant",
343343
"metadata": {},
344344
"outputs": [],
345345
"source": [
@@ -348,7 +348,7 @@
348348
},
349349
{
350350
"cell_type": "markdown",
351-
"id": "portuguese-building",
351+
"id": "surface-spending",
352352
"metadata": {},
353353
"source": [
354354
"#### Asynchronous"
@@ -357,7 +357,7 @@
357357
{
358358
"cell_type": "code",
359359
"execution_count": 10,
360-
"id": "essential-import",
360+
"id": "aggressive-pocket",
361361
"metadata": {},
362362
"outputs": [],
363363
"source": [
@@ -367,7 +367,7 @@
367367
},
368368
{
369369
"cell_type": "markdown",
370-
"id": "perceived-broad",
370+
"id": "apart-legislature",
371371
"metadata": {},
372372
"source": [
373373
"<div class=\"alert alert-info\">\n",
@@ -378,31 +378,31 @@
378378
},
379379
{
380380
"cell_type": "markdown",
381-
"id": "rough-buffalo",
381+
"id": "demographic-bailey",
382382
"metadata": {},
383383
"source": [
384384
"## Update data"
385385
]
386386
},
387387
{
388388
"cell_type": "markdown",
389-
"id": "damaged-solution",
389+
"id": "textile-marine",
390390
"metadata": {},
391391
"source": [
392392
"Similarly to the examples about feeding, we can update a batch of data for convenience or update individual data points for increased control."
393393
]
394394
},
395395
{
396396
"cell_type": "markdown",
397-
"id": "unable-sodium",
397+
"id": "civic-coalition",
398398
"metadata": {},
399399
"source": [
400400
"### Batch"
401401
]
402402
},
403403
{
404404
"cell_type": "markdown",
405-
"id": "urban-radar",
405+
"id": "circular-session",
406406
"metadata": {},
407407
"source": [
408408
"We need to prepare the data as a list of dicts having the `id` key holding a unique id of the data point, the `fields` key holding a dict with the fields to be updated and an optional `create` key with a boolean value to indicate if a data point should be created in case it does not exist (default to `False`)."
@@ -411,7 +411,7 @@
411411
{
412412
"cell_type": "code",
413413
"execution_count": 11,
414-
"id": "brutal-third",
414+
"id": "induced-correction",
415415
"metadata": {},
416416
"outputs": [],
417417
"source": [
@@ -426,10 +426,18 @@
426426
"]"
427427
]
428428
},
429+
{
430+
"cell_type": "markdown",
431+
"id": "presidential-kitchen",
432+
"metadata": {},
433+
"source": [
434+
"We then update the batch on the desired schema using the [update_batch](../../reference-api.rst#update-batch) method."
435+
]
436+
},
429437
{
430438
"cell_type": "code",
431439
"execution_count": 12,
432-
"id": "rural-mainstream",
440+
"id": "otherwise-directive",
433441
"metadata": {},
434442
"outputs": [],
435443
"source": [
@@ -438,23 +446,23 @@
438446
},
439447
{
440448
"cell_type": "markdown",
441-
"id": "statutory-sympathy",
449+
"id": "proprietary-gossip",
442450
"metadata": {},
443451
"source": [
444452
"### Individual data points"
445453
]
446454
},
447455
{
448456
"cell_type": "markdown",
449-
"id": "pleasant-aquatic",
457+
"id": "resistant-dubai",
450458
"metadata": {},
451459
"source": [
452460
"We can update individual data points synchronously or asynchronously."
453461
]
454462
},
455463
{
456464
"cell_type": "markdown",
457-
"id": "maritime-mounting",
465+
"id": "jewish-sixth",
458466
"metadata": {},
459467
"source": [
460468
"#### Synchronous"
@@ -463,7 +471,7 @@
463471
{
464472
"cell_type": "code",
465473
"execution_count": 13,
466-
"id": "consistent-nashville",
474+
"id": "varied-radio",
467475
"metadata": {},
468476
"outputs": [],
469477
"source": [
@@ -472,7 +480,7 @@
472480
},
473481
{
474482
"cell_type": "markdown",
475-
"id": "younger-pantyhose",
483+
"id": "champion-light",
476484
"metadata": {},
477485
"source": [
478486
"#### Asynchronous"
@@ -481,7 +489,7 @@
481489
{
482490
"cell_type": "code",
483491
"execution_count": 14,
484-
"id": "blank-covering",
492+
"id": "grave-china",
485493
"metadata": {},
486494
"outputs": [],
487495
"source": [
@@ -491,7 +499,7 @@
491499
},
492500
{
493501
"cell_type": "markdown",
494-
"id": "wrapped-adult",
502+
"id": "organized-montreal",
495503
"metadata": {},
496504
"source": [
497505
"<div class=\"alert alert-info\">\n",
@@ -502,40 +510,40 @@
502510
},
503511
{
504512
"cell_type": "markdown",
505-
"id": "inner-bulletin",
513+
"id": "mechanical-border",
506514
"metadata": {},
507515
"source": [
508516
"## Delete data"
509517
]
510518
},
511519
{
512520
"cell_type": "markdown",
513-
"id": "special-metro",
521+
"id": "miniature-invalid",
514522
"metadata": {},
515523
"source": [
516524
"Similarly to the examples about feeding, we can delete a batch of data for convenience or delete individual data points for increased control."
517525
]
518526
},
519527
{
520528
"cell_type": "markdown",
521-
"id": "patient-campbell",
529+
"id": "primary-wheel",
522530
"metadata": {},
523531
"source": [
524532
"### Batch"
525533
]
526534
},
527535
{
528536
"cell_type": "markdown",
529-
"id": "plain-hamilton",
537+
"id": "cross-serum",
530538
"metadata": {},
531539
"source": [
532-
"We need to prepare the data as a list of dicts having the `id` key holding a unique id of the data point."
540+
"We need to prepare the data as a list of dicts having the `id` key holding a unique id of the data point. We then delete the batch from the desired schema using the [delete_batch](../../reference-api.rst#delete-batch) method."
533541
]
534542
},
535543
{
536544
"cell_type": "code",
537545
"execution_count": 15,
538-
"id": "bacterial-calendar",
546+
"id": "healthy-spell",
539547
"metadata": {},
540548
"outputs": [],
541549
"source": [
@@ -545,23 +553,23 @@
545553
},
546554
{
547555
"cell_type": "markdown",
548-
"id": "express-corruption",
556+
"id": "short-mississippi",
549557
"metadata": {},
550558
"source": [
551559
"### Individual data points"
552560
]
553561
},
554562
{
555563
"cell_type": "markdown",
556-
"id": "dedicated-diamond",
564+
"id": "global-tolerance",
557565
"metadata": {},
558566
"source": [
559567
"We can delete individual data points synchronously or asynchronously."
560568
]
561569
},
562570
{
563571
"cell_type": "markdown",
564-
"id": "declared-consumer",
572+
"id": "handled-tucson",
565573
"metadata": {},
566574
"source": [
567575
"#### Synchronous"
@@ -570,7 +578,7 @@
570578
{
571579
"cell_type": "code",
572580
"execution_count": 16,
573-
"id": "previous-champion",
581+
"id": "white-chamber",
574582
"metadata": {},
575583
"outputs": [],
576584
"source": [
@@ -579,7 +587,7 @@
579587
},
580588
{
581589
"cell_type": "markdown",
582-
"id": "advance-nigeria",
590+
"id": "pacific-implement",
583591
"metadata": {},
584592
"source": [
585593
"#### Asynchronous"
@@ -588,7 +596,7 @@
588596
{
589597
"cell_type": "code",
590598
"execution_count": 17,
591-
"id": "seventh-sherman",
599+
"id": "wrapped-actor",
592600
"metadata": {},
593601
"outputs": [],
594602
"source": [
@@ -598,7 +606,7 @@
598606
},
599607
{
600608
"cell_type": "markdown",
601-
"id": "alpine-laptop",
609+
"id": "entitled-conservative",
602610
"metadata": {},
603611
"source": [
604612
"<div class=\"alert alert-info\">\n",

0 commit comments

Comments
 (0)