2018-12-13 14:47:20 -05:00
---
2019-08-21 00:48:59 -04:00
id: google
2018-12-13 14:47:20 -05:00
title: "Google Cloud Storage"
---
2018-11-13 12:38:37 -05:00
<!--
~ Licensed to the Apache Software Foundation (ASF) under one
~ or more contributor license agreements. See the NOTICE file
~ distributed with this work for additional information
~ regarding copyright ownership. The ASF licenses this file
~ to you under the Apache License, Version 2.0 (the
~ "License"); you may not use this file except in compliance
~ with the License. You may obtain a copy of the License at
~
~ http://www.apache.org/licenses/LICENSE-2.0
~
~ Unless required by applicable law or agreed to in writing,
~ software distributed under the License is distributed on an
~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
~ KIND, either express or implied. See the License for the
~ specific language governing permissions and limitations
~ under the License.
-->
2016-11-16 03:36:45 -05:00
2019-08-21 00:48:59 -04:00
To use this Apache Druid (incubating) extension, make sure to [include ](../../development/extensions.md#loading-extensions ) `druid-google-extensions` extension.
2016-11-16 03:36:45 -05:00
## Deep Storage
2019-08-21 00:48:59 -04:00
Deep storage can be written to Google Cloud Storage either via this extension or the [druid-hdfs-storage extension ](../extensions-core/hdfs.md ).
2018-07-05 12:53:41 -04:00
### Configuration
|Property|Possible Values|Description|Default|
|--------|---------------|-----------|-------|
|`druid.storage.type`|google||Must be set.|
|`druid.google.bucket`||GCS bucket name.|Must be set.|
|`druid.google.prefix`||GCS prefix.|Must be set.|
2016-11-16 03:36:45 -05:00
## Firehose
2019-08-21 00:48:59 -04:00
< a name = "firehose" > < / a >
2016-11-16 03:36:45 -05:00
#### StaticGoogleBlobStoreFirehose
This firehose ingests events, similar to the StaticS3Firehose, but from an Google Cloud Store.
As with the S3 blobstore, it is assumed to be gzipped if the extension ends in .gz
2019-08-21 00:48:59 -04:00
This firehose is _splittable_ and can be used by [native parallel index tasks ](../../ingestion/native-batch.md#parallel-task ).
2018-08-07 02:59:42 -04:00
Since each split represents an object in this firehose, each worker task of `index_parallel` will read an object.
2016-11-16 03:36:45 -05:00
Sample spec:
```json
"firehose" : {
"type" : "static-google-blobstore",
"blobs": [
{
"bucket": "foo",
"path": "/path/to/your/file.json"
},
{
2017-02-06 05:22:17 -05:00
"bucket": "bar",
2016-11-16 03:36:45 -05:00
"path": "/another/path.json"
}
]
}
```
2017-05-18 02:37:18 -04:00
This firehose provides caching and prefetching features. In IndexTask, a firehose can be read twice if intervals or
shardSpecs are not specified, and, in this case, caching can be useful. Prefetching is preferred when direct scan of objects is slow.
2016-11-16 03:36:45 -05:00
|property|description|default|required?|
|--------|-----------|-------|---------|
2017-05-18 02:37:18 -04:00
|type|This should be `static-google-blobstore` .|N/A|yes|
2016-11-16 03:36:45 -05:00
|blobs|JSON array of Google Blobs.|N/A|yes|
2017-05-25 17:13:04 -04:00
|maxCacheCapacityBytes|Maximum size of the cache space in bytes. 0 means disabling cache. Cached files are not removed until the ingestion task completes.|1073741824|no|
|maxFetchCapacityBytes|Maximum size of the fetch space in bytes. 0 means disabling prefetch. Prefetched files are removed immediately once they are read.|1073741824|no|
2017-05-18 02:37:18 -04:00
|prefetchTriggerBytes|Threshold to trigger prefetching Google Blobs.|maxFetchCapacityBytes / 2|no|
|fetchTimeout|Timeout for fetching a Google Blob.|60000|no|
|maxFetchRetry|Maximum retry for fetching a Google Blob.|3|no|
2016-11-16 03:36:45 -05:00
Google Blobs:
|property|description|default|required?|
|--------|-----------|-------|---------|
|bucket|Name of the Google Cloud bucket|N/A|yes|
|path|The path where data is located.|N/A|yes|