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

0.6 API Updates - Mandatory notNull flag in field schemas #291

Open
martin-traverse opened this issue Jan 30, 2023 · 1 comment
Open

0.6 API Updates - Mandatory notNull flag in field schemas #291

martin-traverse opened this issue Jan 30, 2023 · 1 comment

Comments

@martin-traverse
Copy link
Contributor

notNull was added to field schemas as an optional flag during the 0.5 series. If it is omitted, the default behaviour is to respect the businessKey flag.

For 0.6 notNull will become mandatory, so if businessKey = true then you must also set notNull = true. The change needs to be made in the .proto file for schema definitions, and in the schema validator in the validation library. We could also modify the ArrowSchema class that converts schemas between TRAC / Arrow formats, although this is not essential and leaving the existing logic may improve compatability with 0.5 metadata.

This change does not impact the model API, which will still set a default value for notNull if it is not provided.

@martin-traverse
Copy link
Contributor Author

This change has been de-scoped for the 0.6 release series, to avoid breaking changes in the platform API at the current time. However, it still needs to be addressed before the 1.0 release.

@pszajows pszajows removed their assignment Jul 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants