add datastore v1beta3 snippets

[stephenplusplus]

// @pcostell

To Dos

• Entities
• Queries
• Indexes
• Transactions
• Metadata

This is some snippet code in preparation of the datastore v1beta3 release. It's a work in progress, so I wanted to get reviews and guidance on the structure to follow as early as possible.

Some questions:

• Do we have freedom to use taskKey (convention) vs task_key (snippet spreadsheet) - the linter caught this as an error, and I wasn't sure if either is a hard requirement.
• gcloud-node doesn't have an Entity type; data that goes or comes from an entity are just plain JavaScript objects, without special capabilities
• I assume this JavaScript snippet file is meant to be runnable-- as in, instead of dumping out a bunch of vars and function calls, I should box them inside of functions that can be called individually?

Any insight into how the docs are generated from this file, requirements or tips for conventions to follow would be helpful to make sure I get this right. Thanks!

[pcostell]

• taskKey is perfectly fine in this context, whatever is language idiomatic.
• For the case of snippets like basic_entity, just show creating a javascript object with the appropriate fields.
• Yes, all of our snippets are runnable (and do basic smoke tests to make sure the snippet is correct).

Snippets are handled using different regions. So for the basic_entity region this could look in code something like:

function testBasicEntity() {
  // [START basic_entity]
  var task = { .... };
  // [END basic_entity]
  datastore.put(task); // Just a smoke test to make sure the test doesn't fail.
}

One thing to note about the snippet is that is removes the appropriate whitespace, so don't have to worry about the snippets being at a top level.

In general, if an operation is not possible either provide a comment with a workaround or a comment that says it's not possible. For example some of our clients don't expose the insert command, so instead we show a transaction that does a get, verifies that it fails, then performs a put.

[pcostell]

Maybe just call these task.

[stephenplusplus]

Thanks for the review! I pushed some updates, let me know if I'm headed in the right direction. (updated first post with todos - feel free to add on)

[stephenplusplus]

(temporary until release: googleapis/google-cloud-node#897)

[pcostell]

I think it's be ok here to do things in a language idomatic way and call this percentComplete.

[theacodes]

+1, other node.js + datastore samples use camelCase.

[stephenplusplus]

👍

[stephenplusplus]

Oh, this will change the indexes though, which are currently:

indexes:
- kind: Task
  properties:
  - name: done
  - name: priority
    direction: desc
- kind: Task
  properties:
  - name: priority
  - name: percent_complete
- kind: Task
  properties:
  - name: type
  - name: priority
- kind: Task
  properties:
  - name: priority
  - name: created
- kind: Task
  properties:
  - name: done
  - name: created
- kind: Task
  properties:
  - name: type
  - name: priority
    direction: desc
- kind: Task
  properties:
  - name: type
  - name: created

I was planning to include that file in this repo, but wherever it goes the percent_complete will have to be changed to match if we camelcase it.

[pcostell]

So far the entity stuff LGTM

[stephenplusplus]

The query files are up, please let me know if things look good.

[pcostell]

No need to insert on this snippet.

[stephenplusplus]

@pcostell thanks! I've made the requested changes in the last few commits.

[stephenplusplus]

All the sections are covered now.

[pcostell]

We should build (and the other comments) in a language-agnostic way into the docs around the snippets, so no need to include them here.