Skip to content

docs: Add Binary Type #3307

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

Closed
wants to merge 2 commits into from
Closed

docs: Add Binary Type #3307

wants to merge 2 commits into from

Conversation

MichelDiz
Copy link
Contributor

@MichelDiz MichelDiz commented Apr 20, 2019

Doc Binary Type.


This change is Reviewable

Copy link
Contributor

@danielmai danielmai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 3 of 3 files at r1.
Reviewable status: all files reviewed, 5 unresolved discussions (waiting on @MichelDiz)


query/common_test.go, line 255 at r1 (raw file):

created_at                     : datetime @index(hour) .
updated_at                     : datetime @index(year) .
bin_data                         : binary .

nit: align colons like the rest of the schema.


query/common_test.go, line 437 at r1 (raw file):

		<101> <alias> "John Oliver" .

		<1> <bin_data> "YmluLWRhdGE="^^<xs:base64Binary> .

This is nice to be explicit, even though it's not needed when the schema's already set to bin_data: binary . 👍


wiki/content/mutations/index.md, line 207 at r1 (raw file):

See the section on [RDF schema types]({{< relref "query-language/index.md#rdf-types" >}}) to understand how RDF types affect mutations and storage.

Thanks for fixing the link!


wiki/content/query-language/index.md, line 2010 at r1 (raw file):

|  `string`   | string  |
|  `bool`     | bool    |
|  `binary`   | base64  |

I think binary is a []byte in Go according to conversion.go.


wiki/content/query-language/index.md, line 2030 at r1 (raw file):

#### Binary Type

The `binary` represents arbitrary Base64-encoded binary data. For base64Binary data the entire binary stream is encoded using the Base64 Encoding.

Need to double-check that the data is stored as a []byte but returned in JSON responses and exports as base64-encoded strings.

@danielmai danielmai changed the title Add Binary Type docs: Add Binary Type Apr 21, 2019
@danielmai danielmai added the area/documentation Documentation related issues. label Apr 21, 2019
@MichelDiz MichelDiz closed this Apr 26, 2019
@MichelDiz MichelDiz deleted the micheldiz/docs_base64 branch April 26, 2019 21:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Documentation related issues.
Development

Successfully merging this pull request may close these issues.

2 participants