Skip to content

Commit

Permalink
+ curl responses
Browse files Browse the repository at this point in the history
comment out examples without the response
  • Loading branch information
Stanley committed Nov 19, 2011
1 parent b62b6c5 commit 04ef147
Show file tree
Hide file tree
Showing 5 changed files with 149 additions and 182 deletions.
143 changes: 25 additions & 118 deletions GRAPH.1
Expand Up @@ -48,7 +48,25 @@ Wszystkie przykłady interakcji z API korzystają z prostego narzędzia konsoli
.
.nf

curl http://graph\.bagate\.la \-\-verbose
$ curl http://graph\.bagate\.la \-\-verbose
* About to connect() to graph\.bagate\.la port 80 (#0)
* Trying 31\.222\.178\.135\.\.\. connected
> GET / HTTP/1\.1
> User\-Agent: curl/7\.22\.0 (x86_64\-unknown\-linux\-gnu) libcurl/7\.22\.0 OpenSSL/1\.0\.0e zlib/1\.2\.5 libssh2/1\.3\.0
> Host: graph\.bagate\.la
> Accept: */*
>
< HTTP/1\.1 200 OK
< Server: nginx/1\.0\.9
< Date: Thu, 17 Nov 2011 18:27:44 GMT
< Content\-Type: application/json;charset=UTF\-8
< Transfer\-Encoding: chunked
< Connection: keep\-alive
< Access\-Control\-Allow\-Origin: *
<
* Connection #0 to host graph\.bagate\.la left intact
* Closing connection #0
{"version":"0\.7\-SNAPSHOT","name":"Rexster: A Graph Server","graphs":["demo"],"queryTime":0\.138796,"upTime":"0[d]:00[h]:03[m]:40[s]"}
.
.fi
.
Expand Down Expand Up @@ -82,7 +100,8 @@ Przykładowe użycie:
.
.nf

curl http://graph\.bagate\.la/2011\-08\-18/
$ curl http://graph\.bagate\.la/demo/
{"version":"0\.7\-SNAPSHOT","name":"demo","graph":"readonlyindexablegraph[orientgraph[local:\e/home\e/orientdb\e/demo]]","readOnly":true,"type":"com\.tinkerpop\.blueprints\.pgm\.impls\.orientdb\.OrientGraph","queryTime":2\.618832,"upTime":"0[d]:00[h]:04[m]:51[s]","extensions":[{"title":"evaluate an ad\-hoc Gremlin script for a graph\.","method":"GET","href":"tp\e/gremlin"},{"title":"evaluate an ad\-hoc Gremlin script for a graph\.","method":"POST","href":"tp\e/gremlin"}]}
.
.fi
.
Expand Down Expand Up @@ -151,7 +170,8 @@ Przykładowe użycie:
.
.nf

curl http://graph\.bagate\.la/2011\-09\-09/vertices/7
$ curl http://graph\.bagate\.la/demo/vertices/7:77
{"version":"0\.7\-SNAPSHOT","results":{"lon":19\.93278833333333,"name":"Teatr Bagatela","lat":50\.06352999999999,"_id":"#7:77","_type":"vertex"},"queryTime":1\.458626}
.
.fi
.
Expand Down Expand Up @@ -201,7 +221,7 @@ Przykładowe użycie:
.
.nf

curl http://graph\.bagate\.la/2011\-11\-10/vertices/31/outE?_label=connects
$ curl http://graph\.bagate\.la/2011\-11\-10/vertices/31/outE?_label=connects
.
.fi
.
Expand Down Expand Up @@ -313,35 +333,6 @@ Odpowiedź: lista węzłów spełniających kryteria tj\. zawierają \fIfrazę\f
Frazę można doprecyzować, dopisując przed nią \fIname:\fR lub \fIaddress:\fR, co ograniczy wyszukiwanie do określonego pola\.
.
.P
Przykładowe użycia:
.
.IP "" 4
.
.nf

curl \-XGET http://graph\.bagate\.la/2011\-11\-15/search?q=baszt*
.
.fi
.
.IP "" 0
.
.P
Zwróci wszystkie węzły, których nazwa lub lokalizacja zawiera słowo zaczynające się od: \fI"baszt"\fR\.
.
.IP "" 4
.
.nf

curl \-XGET http://graph\.bagate\.la/2011\-11\-15/search?q=dworzec%20AND%20location:basztowa
.
.fi
.
.IP "" 0
.
.P
Zwróci wszystkie węzły, których nazwa lub lokalizacja zawiera słowo \fI"dworzec"\fR, a lokalizacja zawiera słowo \fI"basztowa"\fR\.
.
.P
\fBAlternatywne użycie:\fR
.
.P
Expand All @@ -356,50 +347,14 @@ Metoda: \fBPOST\fR
.P
DSL (język zapytania) jest udokumentowany na stronie: \fIhttp://www\.elasticsearch\.org/guide/reference/query\-dsl/\fR\. Ta forma pozwala formułować bardziej skomplikowane zapytania, ale wymaga znajomości języka\.
.
.P
Przykładowe użycie:
.
.IP "" 4
.
.nf

curl \-XPOST http://graph\.bagate\.la/2011\-11\-15/search \-d \'{
"query": {
"filtered" : {
"query" : {
"match_all" : {}
},
"filter" : {
"geo_distance" : {
"distance" : "1km",
"location" : {
"lat" : 50\.06551,
"lon" : 19\.94693
}
}
}
}
}
}\'
.
.fi
.
.IP "" 0
.
.P
Zwróci wszystkie węzły w promieniu \fI1\fR kilometra od Dworca Głównego w Krakowie (punkt: \fI50\.06551, 19\.94693\fR)\.
.
.P
Zobacz scenariusze testujące\. \fIhttps://github\.com/Stanley/bagatela/blob/master/features/vertex_search\.feature\fR
.
.SH "TRAWERSACJA GRAFU"
Przechodzenie grafu w zdefiniowany sposób\. Zaczynamy zawsze od jednego wierzchołka (lub krawędzi), a następnie, po jego krawędziach (lub jej wierzchołkach), odwiedzamy kolejne encje (wiele w tym samym czasie)\. Celem tego procesu może być uzyskanie np\.: węzłów, krawędzi lub obu tych typów, odwiedzonych w procesie trawersacji\.
.
.P
Do definicji sposobu przechodzenia grafu służy Gremlin \fIhttp://gremlin\.tinkerpop\.com/\fR, będący rozszerzeniem języka Groovy \fIhttp://groovy\.codehaus\.org/\fR\. Pozwala on na wykonywanie szeregu operacji ad\-hoc na grafie\.
.
.P
Ścieżka: \fB/gremlin\fR
Ścieżka: \fB/tp/gremlin\fR
.
.br
Metoda: \fBPOST\fR
Expand Down Expand Up @@ -427,38 +382,6 @@ Parametry:
.P
Odpowiedź: \fI200\fR \- węzły, krawędzie, ścieżka (identyfikatory węzłów i krawędzi) lub pełna ścieżka wraz z atrybutami węzłów i krawędzi\. \fI404\fR \- węzeł \fBid\fR nie istnieje\.
.
.P
Przykładowe użycie:
.
.IP "" 4
.
.nf

curl \-XPOST http://graph\.bagate\.la/2011\-11\-10/gremlin \-d {}
.
.fi
.
.IP "" 0
.
.P
Ścieżka: \fB/gremlin?script=<script>\fR
.
.br
Metoda: \fBGET\fR
.
.br
Parametry: \fBid\fR \- identyfikator węzła początkowego, \fBscript\fR \-
.
.IP "" 4
.
.nf

curl \-XGET http://graph\.bagate\.la/2011\-11\-10/gremlin?script=
.
.fi
.
.IP "" 0
.
.SH "POŁĄCZENIA KOMUNIKACYJNE"
Połączenie komunikacyjne jest ścieżką, która składa się z węzłów, połączonych konkretnym odjazdem (lub przesiadką)\. W przeciwieństwie do zwykłej trawersacji, nie jest to lista wszystkich kursów (odjazdów) w danym połączeniu\. Ponieważ wynik jest związany z czasem, zarówno kursy jak i węzły mogą zależeć od czasu, będącym jednym z parametrów tego zapytania\.
.
Expand Down Expand Up @@ -490,19 +413,3 @@ Parametry ładunku:
.
.P
Odpowiedź: \fI200\fR \- teoretycznie (zgodnie z algorytmem A* \fIhttp://en\.wikipedia\.org/wiki/A*_search_algorithm\fR) najszybsze czasowo połączenie komunikacyjne, pomiędzy dwoma wierzchołkami grafu\.
.
.P
Przykładowe użycie:
.
.IP "" 4
.
.nf

curl
.
.fi
.
.IP "" 0
.
.P
Zobacz scenariusze testujące \fIhttp://relishapp\.com/stanley/bagatela/docs/graph/connections\fR
118 changes: 73 additions & 45 deletions GRAPH.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 04ef147

Please sign in to comment.