Firestore in Datastore mode API - Module Google::Cloud (v2.11.0)

Reference documentation and code samples for the Firestore in Datastore mode API module Google::Cloud.

Methods

.datastore

  def 
  
 self 
 . 
 datastore 
 ( 
 project_id 
  
 = 
  
 nil 
 , 
  
 credentials 
  
 = 
  
 nil 
 , 
  
 scope 
 : 
  
 nil 
 , 
  
 timeout 
 : 
  
 nil 
 , 
  
 database_id 
 : 
  
 nil 
 ) 
  
 - 
>  
 Google 
 :: 
 Cloud 
 :: 
 Datastore 
 :: 
 Dataset 
 

Creates a new object for connecting to the Datastore service. Each call creates a new connection.

For more information on connecting to Google Cloud see the Authentication Guide .

Parameters
  • project_id(String) — Identifier for a Datastore project. If not present, the default project for the credentials is used.
  • credentials(String, Hash, Google::Auth::Credentials) — The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object. (See Datastore::Credentials )
  • scope(String, Array<String>) (defaults to: nil)

    The OAuth 2.0 scopes controlling the set of resources and operations that the connection can access. See Using OAuth 2.0 to Access Google APIs .

    The default scope is:

    • https://www.googleapis.com/auth/datastore
  • timeout(Integer) (defaults to: nil) — Default timeout to use in requests. Optional.
Example
 require 
  
 "google/cloud" 
 datastore 
  
 = 
  
 Google 
 :: 
 Cloud 
 . 
 datastore 
  
 "my-todo-project" 
 , 
  
 "/path/to/keyfile.json" 
 task 
  
 = 
  
 datastore 
 . 
 entity 
  
 "Task" 
 , 
  
 "sampleTask" 
  
 do 
  
 | 
 t 
 | 
  
 t 
 [ 
 "type" 
 ] 
  
 = 
  
 "Personal" 
  
 t 
 [ 
 "done" 
 ] 
  
 = 
  
 false 
  
 t 
 [ 
 "priority" 
 ] 
  
 = 
  
 4 
  
 t 
 [ 
 "description" 
 ] 
  
 = 
  
 "Learn Cloud Datastore" 
 end 
 datastore 
 . 
 save 
  
 task 

#datastore

  def 
  
 datastore 
 ( 
 scope 
 : 
  
 nil 
 , 
  
 timeout 
 : 
  
 nil 
 , 
  
 database_id 
 : 
  
 nil 
 ) 
  
 - 
>  
 Google 
 :: 
 Cloud 
 :: 
 Datastore 
 :: 
 Dataset 
 

Creates a new object for connecting to the Datastore service. Each call creates a new connection.

For more information on connecting to Google Cloud see the Authentication Guide .

Parameters
  • scope(String, Array<String>) (defaults to: nil)

    The OAuth 2.0 scopes controlling the set of resources and operations that the connection can access. See Using OAuth 2.0 to Access Google APIs .

    The default scope is:

    • https://www.googleapis.com/auth/datastore
  • timeout(Integer) (defaults to: nil) — Default timeout to use in requests. Optional.
Examples
 require 
  
 "google/cloud" 
 gcloud 
  
 = 
  
 Google 
 :: 
 Cloud 
 . 
 new 
 datastore 
  
 = 
  
 gcloud 
 . 
 datastore 
 task 
  
 = 
  
 datastore 
 . 
 entity 
  
 "Task" 
  
 do 
  
 | 
 t 
 | 
  
 t 
 [ 
 "type" 
 ] 
  
 = 
  
 "Personal" 
  
 t 
 [ 
 "done" 
 ] 
  
 = 
  
 false 
  
 t 
 [ 
 "priority" 
 ] 
  
 = 
  
 4 
  
 t 
 [ 
 "description" 
 ] 
  
 = 
  
 "Learn Cloud Datastore" 
 end 
 datastore 
 . 
 save 
  
 task 

You shouldn't need to override the default scope, but you can:

 require 
  
 "google/cloud" 
 gcloud 
  
 = 
  
 Google 
 :: 
 Cloud 
 . 
 new 
 platform_scope 
  
 = 
  
 "https://www.googleapis.com/auth/cloud-platform" 
 datastore 
  
 = 
  
 gcloud 
 . 
 datastore 
  
 scope 
 : 
  
 platform_scope 
Design a Mobile Site
View Site in Mobile | Classic
Share by: