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

Improve ORM documentation #88

Open
kilnerm opened this issue Jan 8, 2019 · 3 comments
Open

Improve ORM documentation #88

kilnerm opened this issue Jan 8, 2019 · 3 comments
Labels
bug Something isn't working

Comments

@kilnerm
Copy link
Contributor

kilnerm commented Jan 8, 2019

The ORM documentation needs reviewing and updating to make it a little more comprehensive.

This issue is raised to track the update.

@kilnerm kilnerm added the bug Something isn't working label Jan 8, 2019
@kilnerm
Copy link
Contributor Author

kilnerm commented Jan 8, 2019

Feedback from Slack:

Also one thing that tripped me up was case sensitivity of it all, I had a property in my model with upper case like appId, and I could’t fetch from database due to a cryptic 702 error, something about codable and appId, until I googled and found something about case sensitivity. So now I added CodingKeys to handle the case like appId = “app_id” and then need to use app_id in the query as well. I don’t know if my solution of overriding the CodingKeys is the best, maybe there is a correct way of handling it? If you are going to look into the documentation I would suggest to mention how to handle variable names that contain upper case, it would be useful for future noobs (such as myself) faced with fetching error first thing out of the box, and remove some frustration

@kilnerm
Copy link
Contributor Author

kilnerm commented Jan 17, 2019

The update should include some sample code that demonstrates how to use predefined tables (created using Kuery or direct on the DB) with the ORM.

@kilnerm
Copy link
Contributor Author

kilnerm commented Jan 17, 2019

Add better examples of using QueryParams

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant