diff --git a/data-explorer/kusto/.openpublishing.redirection.json b/data-explorer/kusto/.openpublishing.redirection.json index 8c7b723cda..809b2c94db 100644 --- a/data-explorer/kusto/.openpublishing.redirection.json +++ b/data-explorer/kusto/.openpublishing.redirection.json @@ -62,7 +62,7 @@ }, { "source_path": "management/show-table-mirroring-operations-command.md", - "redirect_url": "/kusto/management/show-table-operations-mirroring-status-command", + "redirect_url": "/kusto/management/show-database-operations-mirroring-statistics", "redirect_document_id": true }, { diff --git a/data-explorer/kusto/management/alter-merge-mirroring-policy-command.md b/data-explorer/kusto/management/alter-merge-mirroring-policy-command.md index 311dc58f4f..63a0894cda 100644 --- a/data-explorer/kusto/management/alter-merge-mirroring-policy-command.md +++ b/data-explorer/kusto/management/alter-merge-mirroring-policy-command.md @@ -3,7 +3,7 @@ title: .alter-merge table policy mirroring command description: Learn how to use the `.alter-merge table policy mirroring` command to create a logical copy of tables of your database. ms.reviewer: sharmaanshul ms.topic: reference -ms.date: 01/12/2025 +ms.date: 03/06/2025 monikerRange: "microsoft-fabric" --- @@ -40,7 +40,7 @@ Changes the tables's [mirroring policy](mirroring-policy.md). The mirroring poli |Name|Type|Description| |--|--|--| |`IsEnabled`| `bool`| A Boolean value that determines whether the mirroring policy is enabled. Default value is `true`. When the mirroring policy is disabled and set to `false`, the underlying mirroring data is soft-deleted and retained in the database. | -|`TargetLatencyInMinutes`| `int`| The write operation delay in minites. By default, the write operation can take up to 3 hours or until there's 256 MB of data available. You can adjust the delay to a value between 5 minutes and 3 hours. | +|`TargetLatencyInMinutes`| `int`| The write operation delay in minutes. By default, the write operation can take up to 3 hours or until there's 256 MB of data available. You can adjust the delay to a value between 5 minutes and 3 hours. | |`Backfill`| `bool`| When set to `true`, mirroring starts from the `EffectiveDateTime`. If `EffectiveDateTime` isn't specified, all of the table data is mirrored. Default value is `false`.| |`EffectiveDateTime`| `datetime`| Relevant when Backfill is set to `true`. If provided, mirroring starts from the specified value.| @@ -62,5 +62,5 @@ In the following example, a table called *myTable* is mirrored. The data is part ## Related content -* To check mirroring operations, see [.show table mirroring operations command](show-table-mirroring-operations-command.md). +* To check mirroring operations, see [.show table operations mirroring-statistics](show-database-operations-mirroring-statistics.md). * To delete mirroring operations, see [.delete table policy mirroring command](delete-table-mirroring-policy-command.md). diff --git a/data-explorer/kusto/management/mirroring-policy.md b/data-explorer/kusto/management/mirroring-policy.md index a5a40843a2..fbabddd8dc 100644 --- a/data-explorer/kusto/management/mirroring-policy.md +++ b/data-explorer/kusto/management/mirroring-policy.md @@ -17,7 +17,8 @@ The mirroring policy commands allow you to view, change, partition, and delete y * Use [.show table policy mirroring command](show-table-mirroring-policy-command.md) to show the current mirroring policy of the table. * Use [.alter-merge table policy mirroring command](alter-merge-mirroring-policy-command.md) to change the current mirroring policy. * Use [.delete table policy mirroring command](delete-table-mirroring-policy-command.md) to soft-delete the current mirroring policy. -* Use [.show table mirroring operations command](show-table-mirroring-operations-command.md) to check operations mirroring status. +* Use [.show database operations mirroring-statistics](show-database-operations-mirroring-statistics.md) to check database operations mirroring statistics. +* Use [.show table operations mirroring-statistics](show-table-operations-mirroring-statistics.md) to check table operations mirroring statistics. * Use [.show table mirroring operations exported artifacts command](show-table-mirroring-operations-exported-artifacts.md) to check operations exported artifacts status. * Use [.show table mirroring operations failures](show-table-mirroring-operations-failures.md) to check operations mirroring failure status. diff --git a/data-explorer/kusto/management/show-database-operations-mirroring-statistics.md b/data-explorer/kusto/management/show-database-operations-mirroring-statistics.md new file mode 100644 index 0000000000..aac8651abb --- /dev/null +++ b/data-explorer/kusto/management/show-database-operations-mirroring-statistics.md @@ -0,0 +1,51 @@ +--- +title: .show database operations mirroring-statistics +description: Learn how to use the `.show database operations mirroring statistics` command to check the mirroring policy operations. +ms.reviewer: sharmaanshul +ms.topic: reference +ms.date: 04/22/2025 +--- + +# .show database operations mirroring-statistics + +> [!INCLUDE [applies](../includes/applies-to-version/applies.md)] [!INCLUDE [fabric](../includes/applies-to-version/fabric.md)] [!INCLUDE [azure-data-explorer](../includes/applies-to-version/azure-data-explorer.md)] + +Displays [mirroring policy](mirroring-policy.md) operations statistics for all tables in the database. Mirroring statistics allows you to verify the latency and status of your data export. + +## Syntax + +`.show` `database` *DatabaseName* `operations` `mirroring-statistics` + +[!INCLUDE [syntax-conventions-note](../includes/syntax-conventions-note.md)] + +## Parameters + +|Name|Type|Required|Description| +|--|--|--|--| +|*DatabaseName*| `string` | :heavy_check_mark:|The name of the database for which to show the operations mirroring statistics.| + +## Returns + +| Property | Type | Description | +|-----|-----|-----| +|DatabaseName| `string` | The name of the database. | +|CompletionPercentage|`int` | The status of the mirroring operation as a percentage. | +|PendingDataSize| `int` | The size of data in bytes that is pending ingestion or processing. | +|MaxLatency| `timespan`| The maximum amount of time in minutes between the last and next time new data was added to your logical copy. | +|NumOfTables| `int`| The number of tables in the database. | + +[!INCLUDE [mirroring-note](../includes/mirroring-note.md)] + +## Example + +The following example requests operations mirroring statistics of the *Telemetry* database. + +```kusto +.show database Telemetry operations mirroring-statistics +``` + +**Output** + +| DatabaseName | CompletionPercentage | PendingDataSize | MaxLatency | NumOfTables | +| ------------------------------------ | -------------------- | --------------- | ---------- | ----------- | +| 4145dac4-ee39-4ec2-aafb-11315b5b7c9b | 100 | 0 | 00:00:00 | 1 | \ No newline at end of file diff --git a/data-explorer/kusto/management/show-external-tables-details.md b/data-explorer/kusto/management/show-external-tables-details.md new file mode 100644 index 0000000000..afda651cab --- /dev/null +++ b/data-explorer/kusto/management/show-external-tables-details.md @@ -0,0 +1,75 @@ +--- +title: .show external table details +description: Learn how to use the `.show external table details` command to show details of the specified external tables in the database. +ms.reviewer: yifats +ms.topic: reference +ms.date: 04/23/2025 +--- +# .show external table details + +> [!INCLUDE [applies](../includes/applies-to-version/applies.md)] [!INCLUDE [fabric](../includes/applies-to-version/fabric.md)] [!INCLUDE [azure-data-explorer](../includes/applies-to-version/azure-data-explorer.md)] + +Returns query acceleration details of a specified external table or all external tables in the database. + +This command is relevant to any external table of any type. For an overview of external tables, see [external tables](../query/schema-entities/external-tables.md). + +## Permissions + +You must have at least Database User, Database Viewer, Database Monitor to run these commands. For more information, see [role-based access control](../access-control/role-based-access-control.md). + +## Syntax + +`.show` `external` `tables` `details` + +`.show` `external` `table` *TableName* `details` + +[!INCLUDE [syntax-conventions-note](../includes/syntax-conventions-note.md)] + +## Parameters + +|Name|Type|Required|Description| +|--|--|--|--| +|*TableName*| `string` | :heavy_check_mark:|The name of the external table to show.| + +## Returns + +| Output parameter | Type | Description | +|--|--|--| +| TableName | `string` | Name of external table | +| QueryAccelerationPolicy | `string` | A JSON-serialization of the [query acceleration policy](#query-acceleration-policy) that is set on the table. | +| QueryAccelerationState | `string` | A JSON-serialization of the [query acceleration status](#query-acceleration-state) parameters. | + +### Query acceleration policy + +| Column | Type | Description | +|--|--|--| +| TableName | `string` | The name of the external table. | +| IsEnabled | `bool` | Indicates whether the external table has a query acceleration policy enabled. | +| Hot | `timespan` | The hot period defined in the query acceleration policy. | + +### Query acceleration state + +| Column | Type | Description | +|--|--|--| +| HotSize | `long` | The total size on disk (in bytes) of artifacts accelerated due to the query acceleration policy. | +| CompletePercentage | `double` | The percentage of artifacts that are accelerated, out of the total artifacts that are able to be accelerated. | +| PendingDataFilesSize | `long` | The total size of artifacts that are pending acceleration. | +| PendingDataFilesCount | `int` | The number of artifacts that are pending acceleration. | +| IsHealthy | `string` | Indicated whether healthy or not health. | +| NotHealthyReason | `string` | Describes the reason for query acceleration not being healthy. Empty if healthy. | +| LastUpdatedDateTime | `datetime` | The last datetime when the internal representation of the table was successfully refreshed. | +| Latency | `timespan` | The time in minutes since the last new data was added to your logical copy. | + +## Example + +```kusto +.show external tables details +.show external table deltatable details +``` + +**Output** + +| TableName | QueryAccelerationPolicy | QueryAccelerationState | +|-----------|-----------|----------------| +| deltatable | { + "IsEnabled": true, "Hot": "365000.00:00:00"} | { "HotSize": 29454192, "CompletionPercentage": 75.0, "PendingArtifactSize": 21162035, "PendingArtifactCount": 3, "IsHealthy": false, "NotHealthyReason": "InaccessibleDeltaTable : Delta table does not exist", "LastUpdatedDateTime": "2025-04-03 13:38:00.1541537", "Latency": "26.00:58:12.8941033"} | diff --git a/data-explorer/kusto/management/show-table-operations-mirroring-statistics.md b/data-explorer/kusto/management/show-table-operations-mirroring-statistics.md new file mode 100644 index 0000000000..fe8cc6f019 --- /dev/null +++ b/data-explorer/kusto/management/show-table-operations-mirroring-statistics.md @@ -0,0 +1,55 @@ +--- +title: .show table operations mirroring-statistics +description: Learn how to use the `.show table operations mirroring-statistics` command to check the mirroring policy operations. +ms.reviewer: sharmaanshul +ms.topic: reference +ms.date: 04/22/2025 +--- +# .show table operations mirroring-statistics + +> [!INCLUDE [applies](../includes/applies-to-version/applies.md)] [!INCLUDE [fabric](../includes/applies-to-version/fabric.md)] [!INCLUDE [azure-data-explorer](../includes/applies-to-version/azure-data-explorer.md)] + +Displays [mirroring policy](mirroring-policy.md) operations statistics for a table. Mirroring statistics allows you to verify the latency and status of your data export. + +## Syntax + +`.show` `table` *TableName* `operations` `mirroring-statistics` + +[!INCLUDE [syntax-conventions-note](../includes/syntax-conventions-note.md)] + +## Parameters + +|Name|Type|Required|Description| +|--|--|--|--| +|*TableName*| `string` | :heavy_check_mark:|The name of the table for which to show the operations mirroring statistics.| + +## Returns + +| Property | Type | Description | +|-----|-----|-----| +|TableName | `string` | The name of the table. | +|IsEnabled | `bool` |Indicates whether or not the mirroring policy is enabled. | +|ManagedIdentityIdentifier |`string` | The identifier of the managed identity | +|IsExportRunning | `bool` | Indicates whether or not the mirroring policy is running. | +|LastExportStartTime | `datetime`| The start time of the last export. | +|LastExportResult | `string` | The status of the last export result. | +|LastExportedDataTime|`datetime` | The time of the last data export. | +|Latency | `timespan` |The maximum amount of time in minutes between the last and next time new data was added to your logical copy. | +|CompletionPercentage|`int` | The percentage of a task or operation completed. | +|PendingDataSize|`int` | The size of data in bytes that is pending ingestion or processing.| + +[!INCLUDE [mirroring-note](../includes/mirroring-note.md)] + +## Example + +The following example requests operations mirroring-statistics of the *MTelemetry* table. + +```kusto +.show table MTelemetry operations mirroring-statistics +``` + +**Output** + +| TableName | IsEnabled | ManagedIdentityIdentifier | IsExportRunning | LastExportStartTime | LastExportResult | LastExportedDataTime | Latency | CompletionPercentage | PendingDataSize | +|--|--|--|--|--|--|--|--|--|--| +| MTelemetry | true | | false | 2025-04-09 18:42:37.3760 | Completed | 2025-04-09 16:47:07.8420 | 00:00:00 | 100 | 0 | \ No newline at end of file diff --git a/data-explorer/kusto/management/toc.yml b/data-explorer/kusto/management/toc.yml index 9c72e60d2b..6c44e4ea33 100644 --- a/data-explorer/kusto/management/toc.yml +++ b/data-explorer/kusto/management/toc.yml @@ -131,6 +131,8 @@ items: href: external-tables-azure-storage.md - name: Create or alter delta external table href: external-tables-delta-lake.md + - name: .show external table details + href: show-external-tables-details.md - name: Manage external table mappings items: - name: .alter external table mapping command @@ -540,9 +542,11 @@ items: - name: .show table policy mirroring command href: show-table-mirroring-policy-command.md displayName: .show table mirroring policy - - name: .show table operations mirroring-status command - href: show-table-operations-mirroring-status-command.md - displayName: .show table mirroring status operations + - name: .show database operations mirroring-statistics + href: show-database-operations-mirroring-statistics.md + - name: .show table operations mirroring-statistics + href: show-table-operations-mirroring-statistics.md + - name: .show table operations mirroring-exported-artifacts command href: show-table-operations-mirroring-exported-artifacts-command.md displayName: .show table mirroring operations exported artifacts diff --git a/data-explorer/kusto/query/toc.yml b/data-explorer/kusto/query/toc.yml index 3868a92438..fc83eeed99 100644 --- a/data-explorer/kusto/query/toc.yml +++ b/data-explorer/kusto/query/toc.yml @@ -1272,7 +1272,7 @@ items: href: variancepif-aggregation-function.md - name: Graph items: - - name: Graph overview + - name: Graph semantics overview href: graph-semantics-overview.md - name: Graph best practices href: graph-best-practices.md