docs/pluggable_storage.rst - pinot - Git at Google

 ..
 .. 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.
 ..

 Pluggable Storage
 =================

 Pinot enables its users to write a PinotFS abstraction layer to store data in a source of truth data layer of their
 choice for offline segments. We do not yet have support for realtime consumption in deep storage.

 Some examples of storage backends(other than local storage) currently supported are:

 * `HadoopFS <https://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-common/FileSystemShell.html>`_
 * `Azure Data Lake <https://azure.microsoft.com/en-us/solutions/data-lake/>`_

 If the above two filesystems do not meet your needs, please feel free to get in touch with us,
 and we can help you out.

 New Storage Type implementation
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 In order to add a new type of storage backend (say, Amazon s3) implement the following class:

 #. S3FS extends `PinotFS <https://github.com/apache/incubator-pinot/blob/master/pinot-filesystem/src/main/java/org/apache/pinot/filesystem/PinotFS.java>`_

 The properties for the stream implementation are to be set in your controller and server configurations, `like so <https://github.com/apache/incubator-pinot/wiki/Pluggable-Storage>`_.
	..
	.. 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.
	..

	Pluggable Storage
	=================

	Pinot enables its users to write a PinotFS abstraction layer to store data in a source of truth data layer of their
	choice for offline segments. We do not yet have support for realtime consumption in deep storage.

	Some examples of storage backends(other than local storage) currently supported are:

	* `HadoopFS <https://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-common/FileSystemShell.html>`_
	* `Azure Data Lake <https://azure.microsoft.com/en-us/solutions/data-lake/>`_

	If the above two filesystems do not meet your needs, please feel free to get in touch with us,
	and we can help you out.

	New Storage Type implementation
	^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	In order to add a new type of storage backend (say, Amazon s3) implement the following class:

	#. S3FS extends `PinotFS <https://github.com/apache/incubator-pinot/blob/master/pinot-filesystem/src/main/java/org/apache/pinot/filesystem/PinotFS.java>`_

	The properties for the stream implementation are to be set in your controller and server configurations, `like so <https://github.com/apache/incubator-pinot/wiki/Pluggable-Storage>`_.