You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cassandra.apache.org by Mahdi Mohammadi <ma...@gmail.com> on 2016/06/06 14:32:59 UTC

Java Driver 3.0 for Apache Cassandra - Documentation Outdated?

Team,

I was checking the documentation for TupleType in DataStax docs here
<https://docs.datastax.com/en/latest-java-driver/java-driver/reference/tupleTypes.html>
and
the code example was like this:

TupleType theType = TupleType.of(DataType.cint(), DataType.text(),
DataType.cfloat());


But in the code, the *TupleType.of* has two additional parameters not
mentioned in the documentation:


*public static TupleType of(ProtocolVersion protocolVersion, CodecRegistry
codecRegistry, DataType... types)*

Maybe I am looking in the wrong place. Could someone please explain how can
I instantiate a *TupleType*?

I have the same question for *Map* type.

Thanks for your help.

===
Best Regards

Re: Java Driver 3.0 for Apache Cassandra - Documentation Outdated?

Posted by Chris Mattmann <ma...@apache.org>.
It’s not about whether DataStax has great documentation or not. 
That’s fine - it’s about the perception of the *first* place to
look for that documentation. If someone came to Apache OODT, 
Nutch, Tika, Lucene, Spark, etc., and we had great documentation 
at JPL to go along with these, as a PMC member for these projects
I would first point to the ASF documentation, or I would work to
make sure the ASF documentation got a look and set of updates 
first. Point them at the company docs, fine, but make sure the ASF
docs are also great as a priority.




On 6/6/16, 4:57 PM, "Michael Kjellman" <mk...@internalcircle.com> wrote:

>I think it comes down to having full time tech writers employed and paid. If Datastax has the $$ to provide a significant benefit to the community (well thought out documentation) that's better than little or no documentation (if it was only done via developers who most likely won't document or do a poor job at documentation).
>
>Having some documentation is much better for the community than the alternative that "the code is the documentation".
>
>Nothing is free.
>
>On Jun 6, 2016, at 4:50 PM, Chris Mattmann <ma...@apache.org>> wrote:
>
>Excellent, why am I the first person to ask that, and why didn’t
>a PMC member point that out right away and why did it take me asking
>to point to the Apache docs.
>
>This is what I am talking about in terms of the Apache community..
>
>
>
>
>
>On 6/6/16, 4:47 PM, "Michael Kjellman" <mk...@internalcircle.com>> wrote:
>
>http://cassandra.apache.org/doc/cql3/CQL.html
>
>On Jun 6, 2016, at 4:42 PM, Mattmann, Chris A (3980) <ch...@jpl.nasa.gov>> wrote:
>
>Hi,
>
>So, the core documentation for a key part of Cassandra is hosted
>at DataStax?
>
>Cheers,
>Chris
>
>++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>Chris Mattmann, Ph.D.
>Chief Architect
>Instrument Software and Science Data Systems Section (398)
>NASA Jet Propulsion Laboratory Pasadena, CA 91109 USA
>Office: 168-519, Mailstop: 168-527
>Email: chris.a.mattmann@nasa.gov<ma...@nasa.gov>
>WWW:  http://sunset.usc.edu/~mattmann/
>++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>Director, Information Retrieval and Data Science Group (IRDS)
>Adjunct Associate Professor, Computer Science Department
>University of Southern California, Los Angeles, CA 90089 USA
>WWW: http://irds.usc.edu/
>++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>
>
>
>
>
>
>
>
>
>
>On 6/6/16, 7:32 AM, "Mahdi Mohammadi" <ma...@gmail.com>> wrote:
>
>Team,
>
>I was checking the documentation for TupleType in DataStax docs here
><https://docs.datastax.com/en/latest-java-driver/java-driver/reference/tupleTypes.html>
>and
>the code example was like this:
>
>TupleType theType = TupleType.of(DataType.cint(), DataType.text(),
>DataType.cfloat());
>
>
>But in the code, the *TupleType.of* has two additional parameters not
>mentioned in the documentation:
>
>
>*public static TupleType of(ProtocolVersion protocolVersion, CodecRegistry
>codecRegistry, DataType... types)*
>
>Maybe I am looking in the wrong place. Could someone please explain how can
>I instantiate a *TupleType*?
>
>I have the same question for *Map* type.
>
>Thanks for your help.
>
>===
>Best Regards
>
>
>

Re: Java Driver 3.0 for Apache Cassandra - Documentation Outdated?

Posted by Michael Kjellman <mk...@internalcircle.com>.
I think it comes down to having full time tech writers employed and paid. If Datastax has the $$ to provide a significant benefit to the community (well thought out documentation) that's better than little or no documentation (if it was only done via developers who most likely won't document or do a poor job at documentation).

Having some documentation is much better for the community than the alternative that "the code is the documentation".

Nothing is free.

On Jun 6, 2016, at 4:50 PM, Chris Mattmann <ma...@apache.org>> wrote:

Excellent, why am I the first person to ask that, and why didn’t
a PMC member point that out right away and why did it take me asking
to point to the Apache docs.

This is what I am talking about in terms of the Apache community..





On 6/6/16, 4:47 PM, "Michael Kjellman" <mk...@internalcircle.com>> wrote:

http://cassandra.apache.org/doc/cql3/CQL.html

On Jun 6, 2016, at 4:42 PM, Mattmann, Chris A (3980) <ch...@jpl.nasa.gov>> wrote:

Hi,

So, the core documentation for a key part of Cassandra is hosted
at DataStax?

Cheers,
Chris

++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Chris Mattmann, Ph.D.
Chief Architect
Instrument Software and Science Data Systems Section (398)
NASA Jet Propulsion Laboratory Pasadena, CA 91109 USA
Office: 168-519, Mailstop: 168-527
Email: chris.a.mattmann@nasa.gov<ma...@nasa.gov>
WWW:  http://sunset.usc.edu/~mattmann/
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Director, Information Retrieval and Data Science Group (IRDS)
Adjunct Associate Professor, Computer Science Department
University of Southern California, Los Angeles, CA 90089 USA
WWW: http://irds.usc.edu/
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++










On 6/6/16, 7:32 AM, "Mahdi Mohammadi" <ma...@gmail.com>> wrote:

Team,

I was checking the documentation for TupleType in DataStax docs here
<https://docs.datastax.com/en/latest-java-driver/java-driver/reference/tupleTypes.html>
and
the code example was like this:

TupleType theType = TupleType.of(DataType.cint(), DataType.text(),
DataType.cfloat());


But in the code, the *TupleType.of* has two additional parameters not
mentioned in the documentation:


*public static TupleType of(ProtocolVersion protocolVersion, CodecRegistry
codecRegistry, DataType... types)*

Maybe I am looking in the wrong place. Could someone please explain how can
I instantiate a *TupleType*?

I have the same question for *Map* type.

Thanks for your help.

===
Best Regards

Re: Java Driver 3.0 for Apache Cassandra - Documentation Outdated?

Posted by Sylvain Lebresne <sy...@datastax.com>.
On Tue, Jun 7, 2016 at 1:50 AM, Chris Mattmann <ma...@apache.org> wrote:

> Excellent, why am I the first person to ask that, and why didn’t
> a PMC member point that out right away and why did it take me asking
> to point to the Apache docs.
>
> This is what I am talking about in terms of the Apache community..
>

You seem to have make your mind on the Cassandra PMC doing a poor
job so you'll probably consider my response as just proof of how bad we are
(since I'm PMC), but I genuinely fail to see what you think was wrong on the
answer given by Nate to this original email. I mean, that original email is
very
explicitly asking a question about the DataStax java driver documentation,
which as we've established is not part of the Cassandra, and Nate helpfully
explained that fact. So I'm curious as to what else you would have wanted
us the PMC to point out as response to that initial email so we can do
better
next time.

Or, to answer your question more directly, no PMC member pointed right
away to the CQL documentation as response to Madhi original email because
his question was not about CQL, it was about the DataStax Java driver.

--
Sylvain


>
>
>
>
>
> On 6/6/16, 4:47 PM, "Michael Kjellman" <mk...@internalcircle.com>
> wrote:
>
> >http://cassandra.apache.org/doc/cql3/CQL.html
> >
> >On Jun 6, 2016, at 4:42 PM, Mattmann, Chris A (3980) <
> chris.a.mattmann@jpl.nasa.gov<ma...@jpl.nasa.gov>>
> wrote:
> >
> >Hi,
> >
> >So, the core documentation for a key part of Cassandra is hosted
> >at DataStax?
> >
> >Cheers,
> >Chris
> >
> >++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
> >Chris Mattmann, Ph.D.
> >Chief Architect
> >Instrument Software and Science Data Systems Section (398)
> >NASA Jet Propulsion Laboratory Pasadena, CA 91109 USA
> >Office: 168-519, Mailstop: 168-527
> >Email: chris.a.mattmann@nasa.gov<ma...@nasa.gov>
> >WWW:  http://sunset.usc.edu/~mattmann/
> >++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
> >Director, Information Retrieval and Data Science Group (IRDS)
> >Adjunct Associate Professor, Computer Science Department
> >University of Southern California, Los Angeles, CA 90089 USA
> >WWW: http://irds.usc.edu/
> >++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
> >
> >
> >
> >
> >
> >
> >
> >
> >
> >
> >On 6/6/16, 7:32 AM, "Mahdi Mohammadi" <mahdix@gmail.com<mailto:
> mahdix@gmail.com>> wrote:
> >
> >Team,
> >
> >I was checking the documentation for TupleType in DataStax docs here
> ><
> https://docs.datastax.com/en/latest-java-driver/java-driver/reference/tupleTypes.html
> >
> >and
> >the code example was like this:
> >
> >TupleType theType = TupleType.of(DataType.cint(), DataType.text(),
> >DataType.cfloat());
> >
> >
> >But in the code, the *TupleType.of* has two additional parameters not
> >mentioned in the documentation:
> >
> >
> >*public static TupleType of(ProtocolVersion protocolVersion, CodecRegistry
> >codecRegistry, DataType... types)*
> >
> >Maybe I am looking in the wrong place. Could someone please explain how
> can
> >I instantiate a *TupleType*?
> >
> >I have the same question for *Map* type.
> >
> >Thanks for your help.
> >
> >===
> >Best Regards
> >
>
>

Re: Java Driver 3.0 for Apache Cassandra - Documentation Outdated?

Posted by Chris Mattmann <ma...@apache.org>.
Excellent, why am I the first person to ask that, and why didn’t
a PMC member point that out right away and why did it take me asking
to point to the Apache docs.

This is what I am talking about in terms of the Apache community..





On 6/6/16, 4:47 PM, "Michael Kjellman" <mk...@internalcircle.com> wrote:

>http://cassandra.apache.org/doc/cql3/CQL.html
>
>On Jun 6, 2016, at 4:42 PM, Mattmann, Chris A (3980) <ch...@jpl.nasa.gov>> wrote:
>
>Hi,
>
>So, the core documentation for a key part of Cassandra is hosted
>at DataStax?
>
>Cheers,
>Chris
>
>++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>Chris Mattmann, Ph.D.
>Chief Architect
>Instrument Software and Science Data Systems Section (398)
>NASA Jet Propulsion Laboratory Pasadena, CA 91109 USA
>Office: 168-519, Mailstop: 168-527
>Email: chris.a.mattmann@nasa.gov<ma...@nasa.gov>
>WWW:  http://sunset.usc.edu/~mattmann/
>++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>Director, Information Retrieval and Data Science Group (IRDS)
>Adjunct Associate Professor, Computer Science Department
>University of Southern California, Los Angeles, CA 90089 USA
>WWW: http://irds.usc.edu/
>++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>
>
>
>
>
>
>
>
>
>
>On 6/6/16, 7:32 AM, "Mahdi Mohammadi" <ma...@gmail.com>> wrote:
>
>Team,
>
>I was checking the documentation for TupleType in DataStax docs here
><https://docs.datastax.com/en/latest-java-driver/java-driver/reference/tupleTypes.html>
>and
>the code example was like this:
>
>TupleType theType = TupleType.of(DataType.cint(), DataType.text(),
>DataType.cfloat());
>
>
>But in the code, the *TupleType.of* has two additional parameters not
>mentioned in the documentation:
>
>
>*public static TupleType of(ProtocolVersion protocolVersion, CodecRegistry
>codecRegistry, DataType... types)*
>
>Maybe I am looking in the wrong place. Could someone please explain how can
>I instantiate a *TupleType*?
>
>I have the same question for *Map* type.
>
>Thanks for your help.
>
>===
>Best Regards
>

Re: Java Driver 3.0 for Apache Cassandra - Documentation Outdated?

Posted by Michael Kjellman <mk...@internalcircle.com>.
http://cassandra.apache.org/doc/cql3/CQL.html

On Jun 6, 2016, at 4:42 PM, Mattmann, Chris A (3980) <ch...@jpl.nasa.gov>> wrote:

Hi,

So, the core documentation for a key part of Cassandra is hosted
at DataStax?

Cheers,
Chris

++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Chris Mattmann, Ph.D.
Chief Architect
Instrument Software and Science Data Systems Section (398)
NASA Jet Propulsion Laboratory Pasadena, CA 91109 USA
Office: 168-519, Mailstop: 168-527
Email: chris.a.mattmann@nasa.gov<ma...@nasa.gov>
WWW:  http://sunset.usc.edu/~mattmann/
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Director, Information Retrieval and Data Science Group (IRDS)
Adjunct Associate Professor, Computer Science Department
University of Southern California, Los Angeles, CA 90089 USA
WWW: http://irds.usc.edu/
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++










On 6/6/16, 7:32 AM, "Mahdi Mohammadi" <ma...@gmail.com>> wrote:

Team,

I was checking the documentation for TupleType in DataStax docs here
<https://docs.datastax.com/en/latest-java-driver/java-driver/reference/tupleTypes.html>
and
the code example was like this:

TupleType theType = TupleType.of(DataType.cint(), DataType.text(),
DataType.cfloat());


But in the code, the *TupleType.of* has two additional parameters not
mentioned in the documentation:


*public static TupleType of(ProtocolVersion protocolVersion, CodecRegistry
codecRegistry, DataType... types)*

Maybe I am looking in the wrong place. Could someone please explain how can
I instantiate a *TupleType*?

I have the same question for *Map* type.

Thanks for your help.

===
Best Regards

Re: Java Driver 3.0 for Apache Cassandra - Documentation Outdated?

Posted by "Mattmann, Chris A (3980)" <ch...@jpl.nasa.gov>.
Hi,

So, the core documentation for a key part of Cassandra is hosted
at DataStax?

Cheers,
Chris

++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Chris Mattmann, Ph.D.
Chief Architect
Instrument Software and Science Data Systems Section (398)
NASA Jet Propulsion Laboratory Pasadena, CA 91109 USA
Office: 168-519, Mailstop: 168-527
Email: chris.a.mattmann@nasa.gov
WWW:  http://sunset.usc.edu/~mattmann/
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Director, Information Retrieval and Data Science Group (IRDS)
Adjunct Associate Professor, Computer Science Department
University of Southern California, Los Angeles, CA 90089 USA
WWW: http://irds.usc.edu/
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++










On 6/6/16, 7:32 AM, "Mahdi Mohammadi" <ma...@gmail.com> wrote:

>Team,
>
>I was checking the documentation for TupleType in DataStax docs here
><https://docs.datastax.com/en/latest-java-driver/java-driver/reference/tupleTypes.html>
>and
>the code example was like this:
>
>TupleType theType = TupleType.of(DataType.cint(), DataType.text(),
>DataType.cfloat());
>
>
>But in the code, the *TupleType.of* has two additional parameters not
>mentioned in the documentation:
>
>
>*public static TupleType of(ProtocolVersion protocolVersion, CodecRegistry
>codecRegistry, DataType... types)*
>
>Maybe I am looking in the wrong place. Could someone please explain how can
>I instantiate a *TupleType*?
>
>I have the same question for *Map* type.
>
>Thanks for your help.
>
>===
>Best Regards

Re: Java Driver 3.0 for Apache Cassandra - Documentation Outdated?

Posted by Nate McCall <na...@thelastpickle.com>.
Thanks for bringing this up, but the Java Driver is a separate project
maintained here:
https://github.com/datastax/java-driver

with it's own mailing list:
https://groups.google.com/a/lists.datastax.com/forum/#!forum/java-driver-user

Documentation for the driver is also maintained by the community in-tree:
https://github.com/datastax/java-driver/tree/3.0/manual




On Mon, Jun 6, 2016 at 9:32 AM, Mahdi Mohammadi <ma...@gmail.com> wrote:

> Team,
>
> I was checking the documentation for TupleType in DataStax docs here
> <
> https://docs.datastax.com/en/latest-java-driver/java-driver/reference/tupleTypes.html
> >
> and
> the code example was like this:
>
> TupleType theType = TupleType.of(DataType.cint(), DataType.text(),
> DataType.cfloat());
>
>
> But in the code, the *TupleType.of* has two additional parameters not
> mentioned in the documentation:
>
>
> *public static TupleType of(ProtocolVersion protocolVersion, CodecRegistry
> codecRegistry, DataType... types)*
>
> Maybe I am looking in the wrong place. Could someone please explain how can
> I instantiate a *TupleType*?
>
> I have the same question for *Map* type.
>
> Thanks for your help.
>
> ===
> Best Regards
>



-- 
-----------------
Nate McCall
Austin, TX
@zznate

CTO
Apache Cassandra Consulting
http://www.thelastpickle.com