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

please improve documentation for schema #5494

Closed
fommil opened this issue Dec 20, 2015 · 6 comments
Closed

please improve documentation for schema #5494

fommil opened this issue Dec 20, 2015 · 6 comments
Assignees

Comments

@fommil
Copy link

fommil commented Dec 20, 2015

This documents three modes for the schema http://orientdb.com/docs/2.1/Schema.html but doesn't say how to specify which mode to use.

@fommil
Copy link
Author

fommil commented Dec 20, 2015

answer classSchema.setStrictMode(true)

@fommil
Copy link
Author

fommil commented Dec 20, 2015

it's also quite difficult to work out how to add a schema entry for a link. For example in

orderItem.createProperty("animal", OType.LINK, animal);

animal has not been defined anywhere.

(and I've found that the property name has to start with out_ for this to actually work)

@fommil fommil changed the title full schema not documented please improve documentation for schema Dec 20, 2015
@fommil
Copy link
Author

fommil commented Dec 20, 2015

@smolinari
Copy link
Contributor

I am not at all knowledgeable about the ODB Java API, but the docs page you referenced is a "get your feet wet" to ODB's capabilities in the "Getting Started" part of ODB's docs. It definitely is not a complete reference.

Here is the section of the docs, which goes into more details about the Java API and setting properties.

http://orientdb.com/docs/last/Java-Schema-Api.html#property

If it still isn't complete to your liking and if you want, you can contribute to improve the docs, by forking the docs here:

https://github.com/orientechnologies/orientdb-docs

and creating PRs with the improvements you'd like to see. You can also use Gitbook to preview any changes you make too.

Scott

@fommil
Copy link
Author

fommil commented Dec 20, 2015

@smolinari thanks. As far as I can tell, these two chapters on Schema are identical.

@smolinari
Copy link
Contributor

Ha! You are absolutely right. Hmm... then my post is totally useless, other than me looking a bit foolish. 😊

The Schema page under the "Getting Started" should be a lot less full of details. That, or the API page needs to be a lot more detailed. And, since you brought up the need for more detail, I'd say it is the latter?

Scott

@luigidellaquila luigidellaquila self-assigned this Dec 21, 2015
@fommil fommil closed this as completed Sep 1, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

4 participants