summaryrefslogtreecommitdiffstats
path: root/src/arrow/java/flight/flight-core/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/arrow/java/flight/flight-core/README.md')
-rw-r--r--src/arrow/java/flight/flight-core/README.md95
1 files changed, 95 insertions, 0 deletions
diff --git a/src/arrow/java/flight/flight-core/README.md b/src/arrow/java/flight/flight-core/README.md
new file mode 100644
index 000000000..37b41ede2
--- /dev/null
+++ b/src/arrow/java/flight/flight-core/README.md
@@ -0,0 +1,95 @@
+<!---
+ 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.
+-->
+
+# Arrow Flight Java Package
+
+Exposing Apache Arrow data on the wire.
+
+[Protocol Description Slides](https://www.slideshare.net/JacquesNadeau5/apache-arrow-flight-overview)
+
+[GRPC Protocol Definition](https://github.com/apache/arrow/blob/master/format/Flight.proto)
+
+## Example usage
+
+* Compile the java tree:
+
+ ```
+ cd java
+ mvn clean install -DskipTests
+ ```
+
+* Go Into the Flight tree
+
+ ```
+ cd flight/flight-core
+ ```
+
+
+* Start the ExampleFlightServer (supports get/put of streams and listing these streams)
+
+ ```
+ mvn exec:exec
+ ```
+
+* In new terminal, run the TestExampleServer to populate the server with example data
+
+ ```
+ cd arrow/java/flight/flight-core
+ mvn surefire:test -DdisableServer=true -Dtest=TestExampleServer
+ ```
+
+## Python Example Usage
+
+* Compile example python headers
+
+ ```
+ mkdir target/generated-python
+ pip install grpcio-tools # or conda install grpcio
+ python -m grpc_tools.protoc -I./src/main/protobuf/ --python_out=./target/generated-python --grpc_python_out=./target/generated-python ../../format/Flight.proto
+ ```
+
+* Connect to the Flight Service
+
+ ```
+ cd target/generated-python
+ python
+ ```
+
+
+ ```
+ import grpc
+ import flight_pb2
+ import flight_pb2_grpc as flightrpc
+ channel = grpc.insecure_channel('localhost:12233')
+ service = flightrpc.FlightServiceStub(channel)
+ ```
+
+* List the Flight from Python
+
+ ```
+ for f in service.ListFlights(flight_pb2.Criteria()): f
+ ```
+
+* Try to Drop
+
+ ```
+ action = flight_pb2.Action()
+ action.type="drop"
+ service.DoAction(action)
+ ```