|
6 | 6 | > the tracking plan for the specific Compass version you can use the following |
7 | 7 | > URL: `https://github.com/mongodb-js/compass/blob/<compass version>/docs/tracking-plan.md` |
8 | 8 |
|
9 | | -Generated on Thu, Oct 23, 2025 |
| 9 | +Generated on Fri, Oct 24, 2025 |
10 | 10 |
|
11 | 11 | ## Table of Contents |
12 | 12 |
|
@@ -170,6 +170,19 @@ Generated on Thu, Oct 23, 2025 |
170 | 170 | - [Index Dropped](#event--IndexDroppedEvent) |
171 | 171 | - [Index Edited](#event--IndexEditedEvent) |
172 | 172 |
|
| 173 | +### Mock Data Generator |
| 174 | + |
| 175 | +- [Mock Data Generator CTA Button Viewed](#event--MockDataGeneratorCtaButtonViewedEvent) |
| 176 | +- [Mock Data Generator Opened](#event--MockDataGeneratorOpenedEvent) |
| 177 | +- [Mock Data Generator Screen Viewed](#event--MockDataGeneratorScreenViewedEvent) |
| 178 | +- [Mock Data Generator Screen Proceeded](#event--MockDataGeneratorScreenProceededEvent) |
| 179 | +- [Mock Data Generator Dismissed](#event--MockDataGeneratorDismissedEvent) |
| 180 | +- [Mock Data JSON Type Changed](#event--MockDataJsonTypeChangedEvent) |
| 181 | +- [Mock Data Faker Method Changed](#event--MockDataFakerMethodChangedEvent) |
| 182 | +- [Mock Data Document Count Changed](#event--MockDataDocumentCountChangedEvent) |
| 183 | +- [Mock Data Script Generated](#event--MockDataScriptGeneratedEvent) |
| 184 | +- [Mock Data Script Copied](#event--MockDataScriptCopiedEvent) |
| 185 | + |
173 | 186 | ### My Queries |
174 | 187 |
|
175 | 188 | - [My Queries Filter](#event--MyQueriesFilterEvent) |
@@ -1965,6 +1978,132 @@ This event is fired when user updates an index. |
1965 | 1978 | - **connection_id** (optional): `string | undefined` |
1966 | 1979 | - The id of the connection associated to this event. |
1967 | 1980 |
|
| 1981 | +## Mock Data Generator |
| 1982 | + |
| 1983 | +<a name="event--MockDataGeneratorCtaButtonViewedEvent"></a> |
| 1984 | + |
| 1985 | +### Mock Data Generator CTA Button Viewed |
| 1986 | + |
| 1987 | +This event is fired when the Mock Data Generator CTA button is viewed. |
| 1988 | + |
| 1989 | +**Properties**: |
| 1990 | + |
| 1991 | +- **button_enabled** (required): `boolean` |
| 1992 | +- **gen_ai_features_enabled** (required): `boolean` |
| 1993 | +- **send_sample_values_enabled** (required): `boolean` |
| 1994 | +- **is_compass_web** (optional): `true | undefined` |
| 1995 | + |
| 1996 | +<a name="event--MockDataGeneratorOpenedEvent"></a> |
| 1997 | + |
| 1998 | +### Mock Data Generator Opened |
| 1999 | + |
| 2000 | +This event is fired when the user clicks the enabled "Generate Mock Data" button in the collection tab header. |
| 2001 | + |
| 2002 | +**Properties**: |
| 2003 | + |
| 2004 | +- **gen_ai_features_enabled** (required): `boolean` |
| 2005 | +- **send_sample_values_enabled** (required): `boolean` |
| 2006 | +- **is_compass_web** (optional): `true | undefined` |
| 2007 | + |
| 2008 | +<a name="event--MockDataGeneratorScreenViewedEvent"></a> |
| 2009 | + |
| 2010 | +### Mock Data Generator Screen Viewed |
| 2011 | + |
| 2012 | +This event is fired when the user views a screen in the Mock Data Generator modal. |
| 2013 | + |
| 2014 | +**Properties**: |
| 2015 | + |
| 2016 | +- **screen** (required): `MockDataGeneratorScreen` |
| 2017 | +- **is_compass_web** (optional): `true | undefined` |
| 2018 | + |
| 2019 | +<a name="event--MockDataGeneratorScreenProceededEvent"></a> |
| 2020 | + |
| 2021 | +### Mock Data Generator Screen Proceeded |
| 2022 | + |
| 2023 | +This event is fired when the user proceeds to the next screen or finishes the mock data generator modal. |
| 2024 | + |
| 2025 | +**Properties**: |
| 2026 | + |
| 2027 | +- **from_screen** (required): `MockDataGeneratorScreen` |
| 2028 | +- **to_screen** (required): `MockDataGeneratorScreen | "finish"` |
| 2029 | +- **is_compass_web** (optional): `true | undefined` |
| 2030 | + |
| 2031 | +<a name="event--MockDataGeneratorDismissedEvent"></a> |
| 2032 | + |
| 2033 | +### Mock Data Generator Dismissed |
| 2034 | + |
| 2035 | +This event is fired when the user closes the mock data generator modal. |
| 2036 | + |
| 2037 | +**Properties**: |
| 2038 | + |
| 2039 | +- **screen** (required): `MockDataGeneratorScreen` |
| 2040 | +- **gen_ai_features_enabled** (required): `boolean` |
| 2041 | +- **send_sample_values_enabled** (required): `boolean` |
| 2042 | +- **is_compass_web** (optional): `true | undefined` |
| 2043 | + |
| 2044 | +<a name="event--MockDataJsonTypeChangedEvent"></a> |
| 2045 | + |
| 2046 | +### Mock Data JSON Type Changed |
| 2047 | + |
| 2048 | +This event is fired when the user changes the JSON type for a MongoDB field type mapping. |
| 2049 | + |
| 2050 | +**Properties**: |
| 2051 | + |
| 2052 | +- **field_name** (required): `string` |
| 2053 | +- **previous_json_type** (required): `MongoDBJsonFieldType` |
| 2054 | +- **new_json_type** (required): `MongoDBJsonFieldType` |
| 2055 | +- **previous_faker_method** (required): `string` |
| 2056 | +- **new_faker_method** (required): `string` |
| 2057 | +- **is_compass_web** (optional): `true | undefined` |
| 2058 | + |
| 2059 | +<a name="event--MockDataFakerMethodChangedEvent"></a> |
| 2060 | + |
| 2061 | +### Mock Data Faker Method Changed |
| 2062 | + |
| 2063 | +This event is fired when the user changes the faker method for a MongoDB field type mapping. |
| 2064 | + |
| 2065 | +**Properties**: |
| 2066 | + |
| 2067 | +- **field_name** (required): `string` |
| 2068 | +- **json_type** (required): `MongoDBJsonFieldType` |
| 2069 | +- **previous_faker_method** (required): `string` |
| 2070 | +- **new_faker_method** (required): `string` |
| 2071 | +- **is_compass_web** (optional): `true | undefined` |
| 2072 | + |
| 2073 | +<a name="event--MockDataDocumentCountChangedEvent"></a> |
| 2074 | + |
| 2075 | +### Mock Data Document Count Changed |
| 2076 | + |
| 2077 | +This event is fired when the user changes the document count for the mock data generator modal. |
| 2078 | + |
| 2079 | +**Properties**: |
| 2080 | + |
| 2081 | +- **document_count** (required): `number` |
| 2082 | +- **is_compass_web** (optional): `true | undefined` |
| 2083 | + |
| 2084 | +<a name="event--MockDataScriptGeneratedEvent"></a> |
| 2085 | + |
| 2086 | +### Mock Data Script Generated |
| 2087 | + |
| 2088 | +This event is fired when the user generates a script in the mock data generator modal. |
| 2089 | + |
| 2090 | +**Properties**: |
| 2091 | + |
| 2092 | +- **field_count** (required): `number` |
| 2093 | +- **output_docs_count** (required): `number` |
| 2094 | +- **is_compass_web** (optional): `true | undefined` |
| 2095 | + |
| 2096 | +<a name="event--MockDataScriptCopiedEvent"></a> |
| 2097 | + |
| 2098 | +### Mock Data Script Copied |
| 2099 | + |
| 2100 | +This event is fired when the user copies the mongosh script in the script screen of the mock data generator modal. |
| 2101 | + |
| 2102 | +**Properties**: |
| 2103 | + |
| 2104 | +- **step** (required): `MockDataScriptStep` |
| 2105 | +- **is_compass_web** (optional): `true | undefined` |
| 2106 | + |
1968 | 2107 | ## My Queries |
1969 | 2108 |
|
1970 | 2109 | <a name="event--MyQueriesFilterEvent"></a> |
|
0 commit comments