libervia-backend: doc/libervia-cli/pubsub.rst annotate

annotate doc/libervia-cli/pubsub.rst @ 3578:efe2445b053c v0.8.0b1

v0.8.0b1 release

author	Goffi <goffi@goffi.org>
date	Fri, 18 Jun 2021 15:10:33 +0200
parents	267e4987b58b
children	7c4fcef5b561 7acf19bdca2f

rev	line source
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3100 diff changeset	1 .. _libervia-cli_pubsub:
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	2
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	3 =========================
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	4 pubsub: PubSub management
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	5 =========================
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	6
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	7 PubSub commands are low level command to handle a PubSub Service.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	8 They are using the generic pubsub arguments
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	9
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	10 For most of those commands, :ref:`pubsub_common` commands are used to specify the
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	11 destination item.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	12
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	13 set
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	14 ===
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	15
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	16 Publish a pubsub item.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	17
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	18 ``stdin`` is used to get the raw XML of the payload of the item to publish.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	19
3100 cea52c9ddfd9 plugin XEP-0060, jp (pubsub/set): publish-options implementation: Goffi <goffi@goffi.org> parents: 3041 diff changeset	20 ``-f KEY VALUE, --field KEY VALUE`` can be used to specify publish options, i.e. option
cea52c9ddfd9 plugin XEP-0060, jp (pubsub/set): publish-options implementation: Goffi <goffi@goffi.org> parents: 3041 diff changeset	21 which must be set if the node already exists, or used if the node is to be created, see
cea52c9ddfd9 plugin XEP-0060, jp (pubsub/set): publish-options implementation: Goffi <goffi@goffi.org> parents: 3041 diff changeset	22 `XEP-0060 §7.1.5`_ for details.
cea52c9ddfd9 plugin XEP-0060, jp (pubsub/set): publish-options implementation: Goffi <goffi@goffi.org> parents: 3041 diff changeset	23
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3100 diff changeset	24 In the same way as for :ref:`libervia-cli_pubsub_node_create`, ``-F, --full-prefix`` can be used if
3100 cea52c9ddfd9 plugin XEP-0060, jp (pubsub/set): publish-options implementation: Goffi <goffi@goffi.org> parents: 3041 diff changeset	25 you need to specify the full option name.
cea52c9ddfd9 plugin XEP-0060, jp (pubsub/set): publish-options implementation: Goffi <goffi@goffi.org> parents: 3041 diff changeset	26
cea52c9ddfd9 plugin XEP-0060, jp (pubsub/set): publish-options implementation: Goffi <goffi@goffi.org> parents: 3041 diff changeset	27 .. _XEP-0060 §7.1.5: https://xmpp.org/extensions/xep-0060.html#publisher-publish-options
cea52c9ddfd9 plugin XEP-0060, jp (pubsub/set): publish-options implementation: Goffi <goffi@goffi.org> parents: 3041 diff changeset	28
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	29 example
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	30 -------
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	31
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	32 Create an item with a custom note XML::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	33
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3100 diff changeset	34 $ echo '<note xmlns="http://example.net/mynotes">this is a note</note>' \| li pubsub set -n "notes"
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	35
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	36 get
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	37 ===
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	38
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	39 Retrieve items from specified node. Default output is prettified and highlighted XML.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	40
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	41 example
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	42 -------
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	43
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	44 Retrieve the last 5 notes from our custom notes node::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	45
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3100 diff changeset	46 $ li pubsub get -n notes -m 5
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	47
3563 267e4987b58b doc: fix remaining SàT references/typos + add `libervia-cli` missing commands Goffi <goffi@goffi.org> parents: 3505 diff changeset	48 .. _li_pubsub_delete:
267e4987b58b doc: fix remaining SàT references/typos + add `libervia-cli` missing commands Goffi <goffi@goffi.org> parents: 3505 diff changeset	49
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	50 delete
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	51 ======
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	52
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	53 Delete an item from a node. If ``-N, --notify`` is specified, subscribers will be notified
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	54 of the item retraction.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	55
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	56 By default a confirmation is requested before deletion is requested to the PubSub service,
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	57 but you can override this behaviour by using ``-f, --force`` option.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	58
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	59 example
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	60 -------
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	61
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	62 Delete item with id ``123456`` from a node::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	63
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3100 diff changeset	64 $ li pubsub delete -n test_node -i 123456
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	65
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	66 edit
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	67 ====
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	68
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	69 Edit the raw XML of an item payload using your local editor (the one set in ``$EDITOR``).
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	70
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	71 If you don't change anything or publish an empty blog post, the edition will be cancelled.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	72
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	73 :ref:`draft_common` commands can be used.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	74
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	75 example
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	76 -------
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	77
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	78 Edit the last note in our custom node::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	79
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3100 diff changeset	80 $ li pubsub edit -n notes -L
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	81
3563 267e4987b58b doc: fix remaining SàT references/typos + add `libervia-cli` missing commands Goffi <goffi@goffi.org> parents: 3505 diff changeset	82 .. _li-pubsub_rename:
267e4987b58b doc: fix remaining SàT references/typos + add `libervia-cli` missing commands Goffi <goffi@goffi.org> parents: 3505 diff changeset	83
267e4987b58b doc: fix remaining SàT references/typos + add `libervia-cli` missing commands Goffi <goffi@goffi.org> parents: 3505 diff changeset	84 rename
267e4987b58b doc: fix remaining SàT references/typos + add `libervia-cli` missing commands Goffi <goffi@goffi.org> parents: 3505 diff changeset	85 ======
267e4987b58b doc: fix remaining SàT references/typos + add `libervia-cli` missing commands Goffi <goffi@goffi.org> parents: 3505 diff changeset	86
267e4987b58b doc: fix remaining SàT references/typos + add `libervia-cli` missing commands Goffi <goffi@goffi.org> parents: 3505 diff changeset	87 Move a item to a new ID. As there is currently no "rename" or "move" operation in XMPP
267e4987b58b doc: fix remaining SàT references/typos + add `libervia-cli` missing commands Goffi <goffi@goffi.org> parents: 3505 diff changeset	88 PubSub, this is done by republishing the item with the new ID, then deleting the old item
267e4987b58b doc: fix remaining SàT references/typos + add `libervia-cli` missing commands Goffi <goffi@goffi.org> parents: 3505 diff changeset	89 if the publication succeed.
267e4987b58b doc: fix remaining SàT references/typos + add `libervia-cli` missing commands Goffi <goffi@goffi.org> parents: 3505 diff changeset	90
267e4987b58b doc: fix remaining SàT references/typos + add `libervia-cli` missing commands Goffi <goffi@goffi.org> parents: 3505 diff changeset	91 This is notably useful when user friendly URL based on ID are used, and one need to fix a
267e4987b58b doc: fix remaining SàT references/typos + add `libervia-cli` missing commands Goffi <goffi@goffi.org> parents: 3505 diff changeset	92 typo or something else.
267e4987b58b doc: fix remaining SàT references/typos + add `libervia-cli` missing commands Goffi <goffi@goffi.org> parents: 3505 diff changeset	93
267e4987b58b doc: fix remaining SàT references/typos + add `libervia-cli` missing commands Goffi <goffi@goffi.org> parents: 3505 diff changeset	94 example
267e4987b58b doc: fix remaining SàT references/typos + add `libervia-cli` missing commands Goffi <goffi@goffi.org> parents: 3505 diff changeset	95 -------
267e4987b58b doc: fix remaining SàT references/typos + add `libervia-cli` missing commands Goffi <goffi@goffi.org> parents: 3505 diff changeset	96
267e4987b58b doc: fix remaining SàT references/typos + add `libervia-cli` missing commands Goffi <goffi@goffi.org> parents: 3505 diff changeset	97 Rename a PubSub item with ID ``123`` to ``456``::
267e4987b58b doc: fix remaining SàT references/typos + add `libervia-cli` missing commands Goffi <goffi@goffi.org> parents: 3505 diff changeset	98
267e4987b58b doc: fix remaining SàT references/typos + add `libervia-cli` missing commands Goffi <goffi@goffi.org> parents: 3505 diff changeset	99 $ li pubsub rename -n some_node -i 123 456
267e4987b58b doc: fix remaining SàT references/typos + add `libervia-cli` missing commands Goffi <goffi@goffi.org> parents: 3505 diff changeset	100
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	101 subscribe
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	102 =========
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	103
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	104 Subscribe to a node.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	105
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	106 Subscription is used to get notifications from the node in case of new/updated item or
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	107 deletion.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	108
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	109 example
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	110 -------
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	111
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	112 Subscribe to an information blog::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	113
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3100 diff changeset	114 $ li pubsub subscribe -n informations -s pubsub.example.net
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	115
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	116 unsubscribe
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	117 ===========
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	118
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	119 Unsubscribe from a node.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	120
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	121 example
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	122 -------
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	123
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	124 Unsubscribe from an information blog::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	125
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3100 diff changeset	126 $ li pubsub unsubscribe -n informations -s pubsub.example.net
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	127
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	128 subscriptions
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	129 =============
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	130
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	131 Retrieve subscriptions for all nodes on a service.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	132
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	133 ``-n NODE, --node NODE`` can be used to request subscriptions for a specific node (e.g. if
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	134 it has subscription with multiple subIDs).
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	135
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	136 example
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	137 -------
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	138
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	139 Retrieve all subscriptions on a pubsub service::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	140
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3100 diff changeset	141 $ li pubsub subscriptions -s pubsub@example.net
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	142
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	143 affiliations
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	144 =============
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	145
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	146 Retrieve affiliations for all nodes at a service.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	147
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	148 ``-n NODE, --node NODE`` can be used to request affiliation for a specific node.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	149
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	150 examples
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	151 --------
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	152
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	153 Retrieve all affiliations at a pubsub service::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	154
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3100 diff changeset	155 $ li pubsub affiliations -s pubsub@example.net
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	156
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	157 Retrieve affiliation for the ``notes`` node::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	158
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3100 diff changeset	159 $ li pubsub affiliations -s pubsub@example.net -n notes
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	160
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	161 search
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	162 ======
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	163
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	164 Search items corresponding to one or more filter(s).
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	165
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	166 ``search`` will check all items (or some of them according to options used) from one or
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	167 several nodes (several nodes can be checked if recursion is used, see below). For each
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	168 item the given filters will be checked, and all corresponding items will be returned.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	169
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	170 This is a resource intensive method (both for server and client), use with caution, and
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	171 use MAM to do searching when suitable.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	172
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	173 filters
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	174 -------
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	175
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	176 To do a search you one or more filters. Filters are checked in the order in which they are
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	177 specified. You can use 4 kinds of filters:
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	178
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	179 ``-t TEXT, --text TEXT``
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	180 do a full-text search. If TEXT is appearing anywhere in the item (including in XML
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	181 tags or arguments), the item is selected
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	182
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	183 ``-r EXPRESSION, --regex EXPRESSION``
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	184 do a regular expression search. `Python standard re module`_ is used internally, so you
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	185 can use its syntax.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	186
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	187 ``-x XPATH, --xpath XPATH``
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	188 use an `XPath version 1.0`_ expression to filter the query. You can have a look at
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	189 `Wikipedia XPath page`_ for a user friendly introduction.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	190
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	191 ``-P PYTHON_CODE, --python PYTHON_CODE``
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	192 use a Python expression to do a test. The expression must return a boolean (``True`` to
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	193 keep item, ``False`` otherwise). From within the Python expression 3 variables are
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	194 defined: ``item`` which contain the raw item as a string, and ``item_xml`` which is the
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	195 parsed XML as an lxml ``etree.Element`` and ``etree`` which is the ``lxml.etree`` module.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	196
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	197 .. _Python standard re module: https://docs.python.org/3.7/library/re.html
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	198 .. _XPath version 1.0: https://www.w3.org/TR/1999/REC-xpath-19991116/
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	199 .. _Wikipedia XPath page: https://en.wikipedia.org/wiki/XPath
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	200
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	201 filter modifiers
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	202 ----------------
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	203
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	204 Before each filter you can specify one or more filter modifiers. A modifier will change
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	205 filter behaviour, it's a flag which can be used either without argument (then it will
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	206 activate the flag), or with an explicit boolean value (i.e. ``true`` or ``false``).
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	207
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	208 The available filters are:
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	209
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	210 ``-C [BOOLEAN], --ignore-case [BOOLEAN]``
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	211 (don't) ignore case. Filters are normally case sensitive, this modifier change this
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	212 behaviour.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	213
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	214 ``-I [BOOLEAN], --invert [BOOLEAN]``
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	215 (don't) invert effect of following filters. This is applying a logical ``NOT`` to the
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	216 filter. This means that instead of keeping item matching the filter, it will keep the
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	217 items which are not matching the filter.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	218
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	219 ``-A [BOOLEAN], --dot-all [BOOLEAN]``
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	220 (don't) use `DOTALL`_ option for regex. This filter only makes sense before a
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	221 ``--regex`` expression.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	222
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	223 ``-k [BOOLEAN], --only-matching [BOOLEAN]``
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	224 (don't) keep only the matching part of the item. Normally the whole item is returned,
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	225 with this flag, only the part matching the filters are kept.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	226
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	227 .. _DOTALL: https://docs.python.org/3.7/library/re.html#re.DOTALL
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	228
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	229 actions
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	230 -------
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	231
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	232 Once filters are set, you may indicate what do to with the found items. By default they
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3100 diff changeset	233 are printed, but you can also use an other li command, or even an external tool.
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	234
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	235 The following actions are available:
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	236
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	237 ``print`` (default)
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	238 pretty print the found items.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	239
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	240 ``exec``
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3100 diff changeset	241 use the given li command on each found item. Everything after the ``exec`` is used to
c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3100 diff changeset	242 indicate the command and arguments to use (you must not specify ``li``, use the command
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	243 directly). The service, node and item will be set to match the found item.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	244
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	245 ``external``
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	246 pipe the raw XML of each item to the given command. Everything after the ``external``
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	247 action is used to indicate the command and arguments to use.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	248
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	249 recursive search
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	250 ----------------
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	251
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	252 By default, only items in the given node will be filtered, but if you specify a recursion
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	253 depth > 0 (using ``-D MAX_DEPTH, --max-depth MAX_DEPTH``), every node linked in item will
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	254 be checked too, then node linked in linked item and so on until depth level is reached.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	255
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	256 For instance, if you want to find all comments of a blog node containing an http(s) link,
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	257 you can do that::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	258
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3100 diff changeset	259 $ li pubsub search -n urn:xmpp:microblog:0 -s user@example.net -D 1 -r 'https?://'
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	260
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	261 examples
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	262 --------
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	263
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	264 Finding all items containing the text "something interesting" in personal blog::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	265
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3100 diff changeset	266 $ li pubsub search -n urn:xmpp:microblog:0 -M -1 -t "something interesting"
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	267
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	268 Find which blog items in the last 20 have a body with less than 200 characters (note that
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	269 body can be either ``<title>`` or ``<content>``, see `XEP-0277`_ for details). Here we use
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	270 a python expression on the text of the body to count the number of characters::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	271
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3100 diff changeset	272 $ li pubsub search -n urn:xmpp:microblog:0 -M 20 --python "len((item_xml.find('.//{http://www.w3.org/2005/Atom}content[@type=\"text\"]') or item_xml.find('.//{http://www.w3.org/2005/Atom}title[@type=\"text\"]')).text) < 200"
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	273
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	274 Find items published by ``toto@example.net`` among last 30 on a blog node, and use
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	275 ``pubsub blog`` command to retrieve id and title. We use ``-N`` to specify the ``pubsub``
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	276 namespace which is used in the XPath expression, then we use ``exec`` to run ``blog get -k
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	277 title -k id`` on found items::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	278
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3100 diff changeset	279 $ li pubsub search -n some_blog_node -s pubsub.example.net -M 30 -N pubsub http://jabber.org/protocol/pubsub -x '/pubsub:item[starts-with(@publisher, "toto@example.net")]' exec blog get -k title -k id
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	280
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	281 Find items which have NOT a title among last 30 items in our personal blog. As
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	282 explained in `XEP-0277`_ Atom's ``<title>`` is always used (even if there is only a body
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	283 and no title), so we actually look for items without ``<content>``. We do that with an
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	284 XPath looking for this ``atom:content`` element, then we use the ``-I [BOOLEAN], --invert
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	285 [BOOLEAN]`` to filter out elements which match.::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	286
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3100 diff changeset	287 $ li pubsub search -n urn:xmpp:microblog:0 -M 30 -I -x //atom:content -N atom http://www.w3.org/2005/Atom
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	288
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	289 Display authors names from last 10 items and their comments, using the ``-k [BOOLEAN],
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	290 --only-matching [BOOLEAN]`` modifier to only display the data we need. We use ``-D 1`` to
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	291 do a recursive search of level 1, which will also look into comments nodes (using last 10
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	292 items there too)::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	293
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3100 diff changeset	294 $ li pubsub search -n urn:xmpp:microblog:0 -M 10 --only-matching -x //atom:author/atom:name -N atom http://www.w3.org/2005/Atom -D 1
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	295
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	296 .. _XEP-0277: https://xmpp.org/extensions/xep-0277.html
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	297
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	298 transform
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	299 =========
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	300
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	301 Modify items using an external command.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	302
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	303 ``transform`` will retrieve requested items, and will send each of them to the standard
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	304 input (stdin) of the specified command. The output of the command will be used, it can be
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	305 3 things:
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	306
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	307 - a raw XML of the modified item, in which case the item will be republished
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	308 - the string ``SKIP``, in which case the item will be ignored
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	309 - the string ``DELETE``, in which case the item will be retracted
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	310
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	311 By default a dry run is done, which means that no item is modified or deleted. To actually
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	312 do the transformation, you have to use ``--apply`` argument.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	313
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	314 If you have to modify the ``publisher`` of an item, you need specific privileges. The
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	315 ``--admin`` allows you do to that, but it must be supported by your PubSub service
3563 267e4987b58b doc: fix remaining SàT references/typos + add `libervia-cli` missing commands Goffi <goffi@goffi.org> parents: 3505 diff changeset	316 (currently only ``Libervia PubSub`` supports this non standard feature).
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	317
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	318 To modify all items of a node, use the ``-A, --all`` option. This will use `RSM`_
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	319 repetitively until all items are treated. Of course that means that your PubSub service
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	320 must support RSM. The items being republished, they will reappear on top of your node,
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	321 that's why it is recommended to use ``--order-by creation`` option when supported by the
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	322 service, to keep consistent order and avoid transforming the same items several times.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	323
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	324 If the command you're using exit with a non zero code, the process will stop. Use ``-I,
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	325 --ignore_errors`` if you want to continue transformation even if an non zero code is
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	326 returned.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	327
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	328 .. _RSM: https://xmpp.org/extensions/xep-0059.html
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	329
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	330 example
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	331 -------
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	332
3505 4705f80b6e23 doc: more renaming Goffi <goffi@goffi.org> parents: 3488 diff changeset	333 Imagine that you want to replace all occurrences of "sàt" by "Libervia" in your personal blog. You first create a Python script like this:
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	334
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	335 .. sourcecode:: python
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	336
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	337 #!/usr/bin/env python3
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	338
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	339 import sys
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	340 item_raw = sys.stdin.read()
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	341 if not "sàt" in item_raw:
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	342 print("SKIP")
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	343 else:
3505 4705f80b6e23 doc: more renaming Goffi <goffi@goffi.org> parents: 3488 diff changeset	344 print(item_raw.replace("sàt", "Libervia"))
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	345
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	346 And save it a some location, e.g. ``~/expand_sat.py`` (don't forget to make is executable
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	347 with ``chmod +x ~/expand_sat.py``).
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	348
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	349 To be sure it's safe, you can first do a dry-run and check the result::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	350
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3100 diff changeset	351 $ li pubsub transform -n urn:xmpp:microblog:0 -A -o creation ~/expand_sat.py
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	352
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	353 Once you have checked that you have the expected behaviour, you can apply the
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	354 transformations::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	355
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3100 diff changeset	356 $ li pubsub transform -n urn:xmpp:microblog:0 -A -o creation --apply ~/expand_sat.py
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	357
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	358 And that's it. You can use the same technique for more complex transformations, including
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	359 modifying the XML (with Python, you can easily do that with standard
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	360 ``xml.etree.ElementTree`` module or with ``lxml.etree``).
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	361
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	362 uri
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	363 ===
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	364
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	365 Build an XMPP URI linking to a PubSub node or item.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	366
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	367 example
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	368 -------
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	369
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	370 Build a link to personal blog::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	371
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3100 diff changeset	372 $ li pubsub uri -n urn:xmpp:microblog:0
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	373
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	374 node
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	375 ====
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	376
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3100 diff changeset	377 Subcommands for node management. Please check :ref:`libervia-cli_pubsub_node`.
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	378
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	379 hook
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	380 ====
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	381
3488 c80a0f864b5d doc: updated doc following global renaming Goffi <goffi@goffi.org> parents: 3100 diff changeset	382 Subcommands for hooks management. Please check :ref:`libervia-cli_pubsub_hook`.

Mercurial > libervia-backend

annotate doc/libervia-cli/pubsub.rst @ 3578:efe2445b053c v0.8.0b1