@@ -153,6 +153,7 @@ Generated on Thu, Feb 20, 2025
153
153
- [ Signal Shown] ( #event--SignalShownEvent )
154
154
155
155
### Schema
156
+ - [ Schema Analysis Cancelled] ( #event--SchemaAnalysisCancelledEvent )
156
157
- [ Schema Analyzed] ( #event--SchemaAnalyzedEvent )
157
158
- [ Schema Exported] ( #event--SchemaExportedEvent )
158
159
@@ -1869,6 +1870,22 @@ This event is fired when signal icon badge is rendered on the screen visible to
1869
1870
1870
1871
## Schema
1871
1872
1873
+ <a name =" event--SchemaAnalysisCancelledEvent " ></a >
1874
+
1875
+ ### Schema Analysis Cancelled
1876
+
1877
+ This event is fired when user analyzes the schema.
1878
+
1879
+ ** Properties** :
1880
+
1881
+ - ** with_filter** (required): ` boolean `
1882
+ - Indicates whether a filter was applied during the schema analysis.
1883
+ - ** analysis_time_ms** (required): ` number `
1884
+ - The time taken when analyzing the schema, before being cancelled, in milliseconds.
1885
+ - ** is_compass_web** (optional): ` true | undefined `
1886
+ - ** connection_id** (optional): ` string | undefined `
1887
+ - The id of the connection associated to this event.
1888
+
1872
1889
<a name =" event--SchemaAnalyzedEvent " ></a >
1873
1890
1874
1891
### Schema Analyzed
@@ -1881,6 +1898,14 @@ This event is fired when user analyzes the schema.
1881
1898
- Indicates whether a filter was applied during the schema analysis.
1882
1899
- ** schema_width** (required): ` number `
1883
1900
- The number of fields at the top level.
1901
+ - ** field_types** (required): ` { [x: string]: number; } `
1902
+ - Key/value pairs of bsonType and count.
1903
+ - ** variable_type_count** (required): ` number `
1904
+ - The count of fields with multiple types in a given schema (not counting undefined).
1905
+ This is only calculated for the top level fields, not nested fields and arrays.
1906
+ - ** optional_field_count** (required): ` number `
1907
+ - The count of fields that don't appear on all documents.
1908
+ This is only calculated for the top level fields, not nested fields and arrays.
1884
1909
- ** schema_depth** (required): ` number `
1885
1910
- The number of nested levels.
1886
1911
- ** geo_data** (required): ` boolean `
@@ -1901,6 +1926,8 @@ This event is fired when user shares the schema.
1901
1926
1902
1927
- ** has_schema** (required): ` boolean `
1903
1928
- Indicates whether the schema was analyzed before sharing.
1929
+ - ** format** (required): ` "standardJSON" | "mongoDBJSON" | "extendedJSON" | "legacyJSON" `
1930
+ - ** source** (required): ` "app_menu" | "schema_tab" `
1904
1931
- ** schema_width** (required): ` number `
1905
1932
- The number of fields at the top level.
1906
1933
- ** schema_depth** (required): ` number `
0 commit comments