Skip to content
New issue

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

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

Already on GitHub? # to your account

fix(databases): Improve documentation for adapters and allow dynamic Knex adapter options #3019

Merged
merged 4 commits into from
Jan 28, 2023

Conversation

daffl
Copy link
Member

@daffl daffl commented Jan 27, 2023

This pull request reviews and improves the MongoDB and Knex adapter documentation.

For the MongoDB adapter:

  • Fixes documentation for transactions
  • Adds documentation for adding indexes
  • Updates the data handling section to focus on ObjectIds with examples that can be dropped directly into a generated application
  • Changes date handling suggestion to use timestamps instead of date strings and objects
  • Removes the "common mistakes" section (this will eventually be addressed in WIP: Docs "Troubleshooting" Guide #2820)

For the SQL Knex adapter:

  • Updates all the documentation to be in line with the current implementation
  • Adds documentation for missing methods
  • Adds documentation for associations and related entries
  • Fixes the setting of dynamic options

Addresses the following issues:

@netlify
Copy link

netlify bot commented Jan 27, 2023

Deploy Preview for feathers-dove canceled.

Name Link
🔨 Latest commit ad08b2b
🔍 Latest deploy log https://app.netlify.com/sites/feathers-dove/deploys/63d4778c122100000881486d

@daffl daffl changed the title fix(databases): Improve documentation for MongoDB and Knex adapter fix(databases): Improve documentation for MongoDB and Knex adapters Jan 27, 2023
@daffl daffl requested a review from marshallswain January 28, 2023 01:00
packages/adapter-tests/src/methods.ts Outdated Show resolved Hide resolved
packages/knex/src/hooks.ts Outdated Show resolved Hide resolved
@daffl daffl merged commit 66c4b5e into dove Jan 28, 2023
@daffl daffl changed the title fix(databases): Improve documentation for MongoDB and Knex adapters fix(databases): Improve documentation for adapters and allow dynamic Knex adapter options Jan 28, 2023
@daffl daffl deleted the database-dove-docs branch January 28, 2023 05:08
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
2 participants