Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion docs/tracking-plan.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# Compass Tracking Plan

Generated on Mon, Oct 14, 2024 at 08:39 AM
Generated on Mon, Oct 14, 2024 at 12:23 PM

## Table of Contents

Expand Down Expand Up @@ -113,6 +113,7 @@ Generated on Mon, Oct 14, 2024 at 08:39 AM

### Indexes
- [Index Created](#event--IndexCreatedEvent)
- [Index Create Failed](#event--IndexCreateFailedEvent)
- [Index Create Opened](#event--IndexCreateOpenedEvent)
- [Index Dropped](#event--IndexDroppedEvent)
- [Index Edited](#event--IndexEditedEvent)
Expand Down Expand Up @@ -1462,6 +1463,35 @@ This event is fired when user creates an index.

**Properties**:

- **unique** (optional): `boolean | undefined`
- Indicates whether the index is unique.
- **ttl** (optional): `any`
- Specifies the time-to-live (TTL) setting for the index.
- **columnstore_index** (optional): `boolean | undefined`
- Indicates whether the index is a columnstore index.
- **has_columnstore_projection** (optional): `any`
- Indicates if the index has a columnstore projection.
- **has_wildcard_projection** (optional): `any`
- Indicates if the index includes a wildcard projection.
- **custom_collation** (optional): `any`
- Specifies if the index uses a custom collation.
- **geo** (optional): `boolean | undefined`
- Indicates whether the index is a geospatial index.
- **atlas_search** (optional): `boolean | undefined`
- Indicates whether the index is an Atlas Search index.
- **type** (optional): `string | undefined`
- Specifies the type of the index.
- **connection_id** (optional): `string | undefined`
- The id of the connection associated to this event.

<a name="event--IndexCreateFailedEvent"></a>

### Index Create Failed

This event is fired when user creates an index and it fails.

**Properties**:

- **unique** (optional): `boolean | undefined`
- Indicates whether the index is unique.
- **ttl** (optional): `any`
Expand Down