[jira] Commented: (AVRO-612) Schema.toString() strips out field docs

["Scott Carey (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/AVRO-612?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12898017#action_12898017 ] 

Scott Carey commented on AVRO-612:
----------------------------------

We need a way to serialize only the 'important' bits of a schema for things like the file format.    Currently, toString() does this minimal version of a schema.  

Is it sufficient to only add 'doc' fields when pretty-printing?

What should we do about custom fields?

> Schema.toString() strips out field docs
> ---------------------------------------
>
>                 Key: AVRO-612
>                 URL: https://issues.apache.org/jira/browse/AVRO-612
>             Project: Avro
>          Issue Type: Bug
>    Affects Versions: 1.3.3
>            Reporter: David Rosenstrauch
>            Priority: Minor
>
> Although avro can successfully parse schema text that contains a "doc" on a Schema.Field, when a Schema containing a field doc is serialized (via Schema.toString()) the doc does not get written.
> The following JUnit test case demonstrates this problem:
> {code:title=TestAvroFieldDocSerialization.java|borderStyle=solid}
> import junit.framework.TestCase;
> import org.apache.avro.Schema;
> public class TestAvroFieldDocSerialization extends TestCase {
> 	public void testAvroFieldDocSerialization() {
> 		String schemaStr =
> 			"{"+
> 			"	\"name\": \"Rec\","+
> 			"	\"type\": \"record\","+
> 			"	\"fields\" : ["+
> 			"		{\"name\": \"f\", \"type\": \"int\", \"doc\": \"test\"}"+
> 			"	]"+
> 			"}";
> 		Schema schema = Schema.parse(schemaStr);
> 		verifyFieldDoc(schema);
> 		schemaStr = schema.toString();
> 		schema = Schema.parse(schemaStr);
> 		verifyFieldDoc(schema);
> 	}
> 	private void verifyFieldDoc(Schema schema) {
> 		Schema.Field field = schema.getField("f");
> 		assertEquals("test", field.doc());
> 	}
> }
> {code}
> Note that the first call to verifyFieldDoc() succeeds, while the second one fails.  They should both succeed (in my opinion).

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.