arcanemachine
The Ecto.Schema docs list some functions that can be used for reflection, e.g. schema.__schema__(:fields).
However, there are some additional clauses in the source code that are not listed in the previously-mentioned docs page, e.g. schema.__schema__(:updatable_fields).
Should I assume that any clause not present in the docs is part of the private API, which could change at any time? Or can I use them all freely?
Where Next?
Trending in Questions
Other Trending Topics
Latest on Elixir Forum
Sponsor Spotlight
Develop your skills with books, videos, and courses.
Categories:
Sub Categories:
Forums
Popular Tags
- #ecto
- #liveview
- #troubleshooting
- #learning-elixir
- #deployment
- #library
- #erlang
- #testing
- #genserver
- #mix
- #absinthe
- #remote-other
- #otp
- #plug
- #how-to-question
- #macros
- #postgres
- #channels
- #elixirconf
- #exunit
- #discussion
- #code-sync
- #javascript
- #podcasts
- #onsite
- #dialyzer
- #docker
- #authentication
- #umbrella
- #full-time-contract
- #podcasts-by-brainlid
- #ecto-query
- #elixir-ls
- #blog-post
- #phoenix_html
- #iex
- #graphql
- #ai
- #genstage
- #elixirconf-us
- #websockets
- #supervisor
- #advent-of-code
- #distillery
- #processes
- #api
- #forms
- #metaprogramming
- #security
- #hex
Our Sponsors
Build Elixir applications with speed and confidence.
Supporting innovation across the BEAM ecosystem.
We build reliable cloud platforms for business-critical systems.
Catch errors, track performance, monitor hosts and more.
Error tracking, logs, uptime, and Just Enough APM. Built for developers.
Practical resources that improve the lives of professional developers.
Develop your skills with books, videos, and courses.
The deployment platform built for Elixir: PaaS ease, VPS control.
The team behind Membrane, Popcorn, LiveDebugger. Available for hire.
Courses that'll move you from confusion to "Aha, now I get it!"
Showing Posts 1 to 6- Show Best Posts
- Show All Posts (oldest first)
- Show All Posts (newest first)
sodapopcan
Both!
Naw I’m just kidding, it’s a good question. I always assume if It’s not documented it’s private, but it could be an oversight. It’s too bad there’s no way to do the equivalent of
@doc falsefor matches.arcanemachine
Just giving this a little bump in the hopes that someone else might see it who can provide some insight.
If this doesn’t work, I might just open a quick issue on GitHub so that this question doesn’t need to come up again in the future.
EDIT: Sorry Brother @sodapopcan, I didn’t mean to reply directly to you.
sodapopcan
That’s all good! I was also hoping someone would give a decisive answer.
arcanemachine
OK so the answer is “Yes, any non-listed one is private.”
https://github.com/elixir-ecto/ecto/issues/4571#issuecomment-2611758297
dimitarvp
IMO not private as in “impossible to access”, but more like “undocumented and subject to change at any time, use at your own risk”. I realize the updated docs say that but “private” is used in the issue so I felt I had to clarify.
arcanemachine
Ah, a subtle but relevant distinction.
Thanks for the clarification, I always get the terms wrong.