Merge pull request #7148 from dyadav7/user/deepyadav/pack_bag_links

Added related links to pack_all,  bag_unpack, bag_pack, updated examples

Author: JamesJBarnett

data-explorer/kusto/query/bag-unpack-plugin.md

@@ -40,7 +40,7 @@ Use a wildcard `*` as the first parameter to include all columns of the source t
 
 Using the plugin without an *OutputSchema* can have severe performance implications in large datasets and should be avoided.
 
-Providing an *OutputSchema* allows the query engine to optimize the query execution, as it can determine the output schema without needing to parse and analyze the input data. This is beneficial when the input data is large or complex. See the [Examples with performance implications](#examples-with-performance-implications) of using the plugin with and without a defined *OutputSchema*.
+Providing an *OutputSchema* allows the query engine to optimize the query execution, as it can determine the output schema without needing to parse and analyze the input data. OutputSchema is beneficial when the input data is large or complex. See the [Examples with performance implications](#examples-with-performance-implications) of using the plugin with and without a defined *OutputSchema*.
 
 ## Returns
 
@@ -196,26 +196,26 @@ datatable(d:dynamic)
 
 :::moniker range="azure-data-explorer"
 > [!div class="nextstepaction"]
-> <a href="https://dataexplorer.azure.com/clusters/help/databases/Samples?query=H4sIAAAAAAAAA0tJLAHCpJxUjRSrlMq8xNzMZE2uaC4FIIByNaqV/BJzU5WsFJS88jPylHQUlBzTgVwjg1pNHRwKXRLLUuEKTfAo9Eoszs3MQ6g1BquN5apRSC1LzClNLElVSEpMjy/NK0hMztZI0VSwUtAA6bUqLinKzEvXUQDqssrJz0vXBADtklvGyQAAAA==" target="_blank">Run the query</a>
+> <a href="https://dataexplorer.azure.com/clusters/help/databases/Samples?query=H4sIAAAAAAAAA0tJLAHCpJxUjRSrlMq8xNzMZE2uaC4FIIByNaqV%2FBJzU5WsFJS88jPylHQUlBzTgVwjg1pNHVSFCnCVLollqSCVHqmZ6RklQBFDcwOYRhNMjQgbEotzM%2FNS4ZYYg9XGctUopJYl5pQmlqQqJCWmx5fmFSQmZ2ukaAIA%2Fh1sgL8AAAA%3D" target="_blank">Run the query</a>
 ::: moniker-end
 
 ```kusto
 datatable(d:dynamic)
 [
     dynamic({"Name": "John", "Age":20}),
-    dynamic({"Name": "Dave", "Age":40}),
+    dynamic({ "Name": "Dave", "Height": 170, "Age":40}),
     dynamic({"Name": "Jasmine", "Age":30}),
 ]
-| evaluate bag_unpack(d) : (Name:string, Age:long)
+| evaluate bag_unpack(d)
 ```
 
 **Output**
 
-|Name  |Age  |
-|---------|---------|
-|John     |  20  |
-|Dave     |  40  |
-|Jasmine  |  30  |
+|Age |Height |Name |
+|--|--|--|
+| 20 | | John |  
+| 40 | 170 | Dave |
+| 30 | | Jasmine |
 
 **Expand a bag with an *OutputSchema* and use the wildcard `*` option**:
 
@@ -299,3 +299,4 @@ The output is the same for both queries. The first 10 rows of the output are sho
 
 * [parse_json function](./parse-json-function.md)
 * [mv-expand operator](./mv-expand-operator.md)
+* [pack-all function](./pack-all-function.md)

data-explorer/kusto/query/pack-all-function.md

@@ -12,7 +12,7 @@ ms.date: 08/11/2024
 Creates a [dynamic](scalar-data-types/dynamic.md) property bag object from all the columns of the tabular expression.
 
 > [!NOTE]
-> The representation of the returned object isn't guaranteed to be byte-level-compatible between runs. For example, properties that appear in the bag may appear in a different order.
+> The representation of the returned object isn't guaranteed to be byte-level-compatible between runs. For example, properties that appear in the bag might appear in a different order.
 
 ## Syntax
 
@@ -28,39 +28,37 @@ Creates a [dynamic](scalar-data-types/dynamic.md) property bag object from all t
 
 ## Example
 
-The following query will use `pack_all()` to create columns for the below table.
-
-|SourceNumber |TargetNumber| CharsCount
-|---|---|---
-|555-555-1234 |555-555-1212 | 46
-|555-555-1234 |555-555-1213 | 50
-|555-555-1313 | | 42
-| |555-555-3456 | 74
+The following query uses `pack_all()` to create packed columns.
 
 :::moniker range="azure-data-explorer"
 > [!div class="nextstepaction"]
-> <a href="https://dataexplorer.azure.com/clusters/help/databases/Samples?query=H4sIAAAAAAAAA32PsQrCMBCG9zxFtrRwgm2SCgWn4uAigm4ikrZHFNOkpCko+PCmIFgXOY6f+/j+4VoV4tQGk4MbfYO7savRl0PwN6vhqLzG8Muqq/JD5UYbSuOsTsmJMCnlYtos54LB7MxyBqKAfwZnIJdzg0+IxV4OlLCZzIUsGKwEJWfyovgIaFu6V80d23Uf46KMSVL4oK22zsd/jNl0fXh+jeBHTN/V81O7+AAAAA==" target="_blank">Run the query</a>
+> <a href="https://dataexplorer.azure.com/clusters/help/databases/Samples?query=H4sIAAAAAAAAA22KvQrCMBSF9zxFttvCFWyTVCg4FQcXEXQTkWgvUYxJSRNQ8OGt0OIiZzh%2FX6vjoLOlbOdTuFDdx3BzBvc6GIpTa6469I1PLtbWO5OzAwOl1KwohQQcY1ECygr%2FPQJQzadHfCsMbImcwQgJqSrAheTsyN6cnpFcy7f6cqd22Q120tZmOY7T2jgfaJOsXT26%2BPoRMSTKPx5KvAnUAAAA" target="_blank">Run the query</a>
 ::: moniker-end
 
 ```kusto
-datatable(SourceNumber:string,TargetNumber:string,CharsCount:long)
+datatable(Source:string,Target:string,CharsCount:long)
 [
-'555-555-1234','555-555-1212',46,
-'555-555-1234','555-555-1213',50,
-'555-555-1313','',42, 
-'','555-555-3456',74 
+'555-1234','555-1212',46,
+'555-1234','555-1213',50,
+'555-1313','',42, 
+'','555-3456',74 
 ]
 | extend Packed=pack_all(), PackedIgnoreNullEmpty=pack_all(true)
 ```
 
 **Output**
 
-|SourceNumber |TargetNumber | CharsCount | Packed |PackedIgnoreNullEmpty
-|---|---|---|---|---
-|555-555-1234 |555-555-1212 | 46 |{"SourceNumber":"555-555-1234", "TargetNumber":"555-555-1212", "CharsCount": 46} | {"SourceNumber":"555-555-1234", "TargetNumber":"555-555-1212", "CharsCount": 46}
-|555-555-1234 |555-555-1213 | 50 |{"SourceNumber":"555-555-1234", "TargetNumber":"555-555-1213", "CharsCount": 50} | {"SourceNumber":"555-555-1234", "TargetNumber":"555-555-1213", "CharsCount": 50}
-|555-555-1313 | | 42 | {"SourceNumber":"555-555-1313", "TargetNumber":"", "CharsCount": 42} | {"SourceNumber":"555-555-1313", "CharsCount": 42}
-| |555-555-3456 | 74 | {"SourceNumber":"", "TargetNumber":"555-555-3456", "CharsCount": 74} | {"TargetNumber":"555-555-3456", "CharsCount": 74}
+|Source |Target | CharsCount | Packed |PackedIgnoreNullEmpty|
+|---|---|---|---|---|
+|555-1234 |555-1212 | 46 |{"Source":"555-1234", "Target":"555-1212", "CharsCount": 46} | {"Source":"555-1234", "Target":"555-1212", "CharsCount": 46}|
+|555-1234 |555-1213 | 50 |{"Source":"555-1234", "Target":"555-1213", "CharsCount": 50} | {"Source":"555-1234", "Target":"555-1213", "CharsCount": 50}|
+|555-1313 | | 42 | {"Source":"555-1313", "Target":"", "CharsCount": 42} | {"Source":"555-1313", "CharsCount": 42}|
+| |555-3456 | 74 | {"Source":"", "Target":"555-3456", "CharsCount": 74} | {"Target":"555-3456", "CharsCount": 74}|
 
 > [!NOTE]
-> There is a difference between the *Packed* and the *PackedIgnoreNullEmpty* columns in the last two rows of the above example. These two rows included empty values that were ignored by *pack_all(true)*.
+> There's a difference between the *Packed* and the *PackedIgnoreNullEmpty* columns in the last two rows of the example. These two rows included empty values that were ignored by *pack_all(true)*.
+
+## Related content
+
+* [bag-pack function](./pack-function.md)
+* [bag-unpack plugin](./bag-unpack-plugin.md)

data-explorer/kusto/query/pack-function.md

@@ -52,15 +52,15 @@ print bag_pack("Level", "Information", "ProcessID", 1234, "Data", bag_pack("url"
 
 |print_0|
 |--|
-|{"Level":"Information","ProcessID":1234,"Data":{"url":"www.bing.com"}}|
+|{"Level": "Information", "ProcessID": 1234, "Data": {"url":"www.bing.com"}}|
 
 **Example 2**
 
 The following example creates a property bag and extract value from property bag using '.' operator.
 
 :::moniker range="azure-data-explorer"
 > [!div class="nextstepaction"]
-> <a href="https://dataexplorer.azure.com/clusters/help/databases/Samples?query=H4sIAAAAAAAAA12PXwuCMBTF3wW%2Fw2VPCiv8V0Hgg9qrTz1GyE3HWMUUXZTQh2%2FTBeL2cvjtnHvPGlT63p4MPNcBfc7tq6%2FZEYRUdCYnNighUYlWLnHJhgG5dg6qF5K7jg%2BX%2BSWM4oRCGAQUSJYRCjNOdvsDhWjCeU7o3xxGFOKJFgXR3qvrfIF9FJMNlGOOPL0hrzqsHx4xXfTARSUd0024hraQb%2BJd395ZrTb4xtF%2BaZWy7vWuypjSSW6NpBabHRYb%2BQMdY4ddNwEAAA%3D%3D" target="_blank">Run the query</a>
+> <a href="https://dataexplorer.azure.com/clusters/help/databases/Samples?query=H4sIAAAAAAAAA12PPwvCMBDF936KI1MLUfpPBaGLOLh00k2kXGsI0ZKUJqIFP7xJzFB6WR4%2F3rt7uaOxr%2B0ZxBHYOavX2LE9CGmoB0emjZBohJIzWjOtkVufNqOQPErg6nmWFyWFLE0pkJMgFDwtN9sdhfxPWd8rQoM7yykUgU8Eolv0BfYxTN6hng7IqxZ5M2D3jIkrYhfO%2BtjUxZotDHUSmx5G9WCdWeEbp%2FCbRSiYF5ca56m8XDtJA3YXAnbyBz3NWFQwAQAA" target="_blank">Run the query</a>
 ::: moniker-end
 
 ```kusto
@@ -69,22 +69,22 @@ datatable (
     Destination: int,
     Message: string
 ) [
-    1234, 100, "AA", 
-    4567, 200, "BB",
-    1212, 300, "CC" 
+    1234, 100, "Hi", 
+    4567, 200, "Hello",
+    1212, 300, "Hey" 
 ]
-| extend MyBag=bag_pack("Dest", Destination, "Mesg", Message)
+| extend MyBag=bag_pack("Dest", Destination, "Text", Message)
 | project-away Source, Destination, Message
-| extend MyBag_Dest=MyBag.Dest, MyBag_Mesg=MyBag.Mesg
+| extend MyBag_Dest=MyBag.Dest, MyBag_Text=MyBag.Text
 ```
 
 **Results**
 
-|MyBag|MyBag_Dest|MyBag_Mesg|
+|MyBag|MyBag_Dest|MyBag_Text|
 |--|--|--|
-|{"Dest":100,"Mesg":"AA"}|100|AA|
-|{"Dest":200,"Mesg":"BB"}|200|BB|
-|{"Dest":300,"Mesg":"CC"}|300|CC|
+|{"Dest":100,"Text":"Hi" }|100|Hi|
+|{"Dest":200,"Text":"Hello" }|200|Hello|
+|{"Dest":300,"Text":"Hey" }|300|Hey|
 
 **Example 3**
 
@@ -147,3 +147,8 @@ SmsMessages
 | 555-555-1234 | 555-555-1212 | {"CharsCount":"46","AttachmentSize":"250","AttachmentType":"jpeg","AttachmentName":"Pic2"} |
 | 555-555-1234 | 555-555-1213 | {"CharsCount":"50","AttachmentSize":"300","AttachmentType":"png","AttachmentName":"Pic3"} |
 | 555-555-1234 | 555-555-1212 | {"CharsCount":"46","AttachmentSize":"300","AttachmentType":"png","AttachmentName":"Pic3"} |
+
+## Related content
+
+* [pack-all function](./pack-all-function.md)
+* [bag-unpack plugin](./bag-unpack-plugin.md)