Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document that adjusting the auto-discovered schema is required #18784

Merged
merged 1 commit into from
Aug 28, 2023
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
16 changes: 10 additions & 6 deletions docs/src/main/sphinx/connector/mongodb.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,9 +210,10 @@ This property is optional; the default is `0`.
MongoDB maintains table definitions on the special collection where `mongodb.schema-collection` configuration value specifies.

:::{note}
There's no way for the plugin to detect a collection is deleted.
You need to delete the entry by `db.getCollection("_schema").remove( { table: deleted_table_name })` in the Mongo Shell.
Or drop a collection by running `DROP TABLE table_name` using Trino.
The plugin cannot detect that a collection has been deleted. You must
delete the entry by executing `db.getCollection("_schema").remove( { table:
deleted_table_name })` in the MongoDB Shell. You can also drop a collection in
Trino by running `DROP TABLE table_name`.
:::

A schema collection consists of a MongoDB document for a table.
Expand All @@ -230,9 +231,12 @@ A schema collection consists of a MongoDB document for a table.
}
```

The connector quotes the fields for a row type when auto-generating the schema.
However, if the schema is being fixed manually in the collection then
the fields need to be explicitly quoted. `row("UpperCase" varchar)`
The connector quotes the fields for a row type when auto-generating the schema;
however, the auto-generated schema must be corrected manually in the collection
to match the information in the tables.

Manually altered fields must be explicitly quoted, for example, `row("UpperCase"
varchar)`.

| Field | Required | Type | Description |
| -------- | -------- | ------ | ------------------------------------------------------------------------------------------- |
Expand Down