Class: Neo4j::Session
- Inherits:
-
Object
show all
- Defined in:
- lib/neo4j/session.rb
Defined Under Namespace
Classes: CypherError, InitializationError
Constant Summary
collapse
- @@current_session =
nil
- @@all_sessions =
{}
- @@factories =
{}
Class Method Summary
collapse
Instance Method Summary
collapse
Class Method Details
._listeners ⇒ Object
181
182
183
184
|
# File 'lib/neo4j/session.rb', line 181
def _listeners
@@listeners ||= []
@@listeners
end
|
._notify_listeners(event, data) ⇒ Object
187
188
189
|
# File 'lib/neo4j/session.rb', line 187
def _notify_listeners(event, data)
_listeners.each { |li| li.call(event, data) }
end
|
.add_listener(&listener) ⇒ Object
176
177
178
|
# File 'lib/neo4j/session.rb', line 176
def add_listener(&listener)
_listeners << listener
end
|
.clear_listeners ⇒ Object
171
172
173
|
# File 'lib/neo4j/session.rb', line 171
def clear_listeners
@@listeners = []
end
|
.create_session(db_type, endpoint_url, params = {}) ⇒ Object
116
117
118
119
120
121
|
# File 'lib/neo4j/session.rb', line 116
def create_session(db_type, endpoint_url, params = {})
unless @@factories[db_type]
fail InitializationError, "Can't connect to database '#{db_type}', available #{@@factories.keys.join(',')}"
end
@@factories[db_type].call(endpoint_url, params)
end
|
Returns the current session.
124
125
126
|
# File 'lib/neo4j/session.rb', line 124
def current
@@current_session
end
|
.current! ⇒ Object
Returns the current session or raise an exception if no session is available
129
130
131
132
|
# File 'lib/neo4j/session.rb', line 129
def current!
fail 'No session, please create a session first with Neo4j::Session.open(:server_db) or :embedded_db' unless current
current
end
|
.inspect ⇒ Object
207
208
209
|
# File 'lib/neo4j/session.rb', line 207
def inspect
"Neo4j::Session available: #{@@factories && @@factories.keys}"
end
|
.named(name) ⇒ Object
Returns a session with given name or else raise an exception
140
141
142
|
# File 'lib/neo4j/session.rb', line 140
def named(name)
@@all_sessions[name] || fail("No session named #{name}.")
end
|
.on_session_available {|Neo4j::Session.current| ... } ⇒ Object
Registers a callback which will be called immediately if session is already available, or called when it later becomes available.
152
153
154
155
156
157
158
|
# File 'lib/neo4j/session.rb', line 152
def on_session_available
yield Neo4j::Session.current if Neo4j::Session.current
add_listener do |event, data|
yield data if event == :session_available
end
end
|
.open(db_type = :server_db, endpoint_url = nil, params = {}) ⇒ Object
Creates a new session to Neo4j. This will be the default session to be used unless there is already a session created (see #current and #set_current)
100
101
102
103
104
105
106
|
# File 'lib/neo4j/session.rb', line 100
def open(db_type = :server_db, endpoint_url = nil, params = {})
validate_session_num!(db_type)
name = params[:name]
default = params[:default]
[:name, :default].each { |k| params.delete(k) }
register(create_session(db_type, endpoint_url, params), name, default)
end
|
.query(*args) ⇒ Object
135
136
137
|
# File 'lib/neo4j/session.rb', line 135
def query(*args)
current!.query(*args)
end
|
.register(session, name = nil, default = nil) ⇒ Object
192
193
194
195
196
197
198
199
200
|
# File 'lib/neo4j/session.rb', line 192
def register(session, name = nil, default = nil)
if default == true
set_current(session)
elsif default.nil?
set_current(session) unless @@current_session
end
@@all_sessions[name] = session if name
session
end
|
.register_db(db, &session_factory) ⇒ Object
212
213
214
215
|
# File 'lib/neo4j/session.rb', line 212
def register_db(db, &session_factory)
puts "replace factory for #{db}" if @@factories[db]
@@factories[db] = session_factory
end
|
.set_current(session) ⇒ Object
Sets the session to be used as default
146
147
148
|
# File 'lib/neo4j/session.rb', line 146
def set_current(session)
@@current_session = session
end
|
.unregister(session) ⇒ Object
203
204
205
|
# File 'lib/neo4j/session.rb', line 203
def unregister(session)
@@current_session = nil if @@current_session == session
end
|
.user_agent_string ⇒ Object
160
161
162
163
164
165
166
167
168
169
|
# File 'lib/neo4j/session.rb', line 160
def user_agent_string
gem, version = if defined?(::Neo4j::ActiveNode)
['neo4j', ::Neo4j::VERSION]
else
['neo4j-core', ::Neo4j::Core::VERSION]
end
"#{gem}-gem/#{version} (https://github.com/neo4jrb/#{gem})"
end
|
.validate_session_num!(db_type) ⇒ Object
109
110
111
112
|
# File 'lib/neo4j/session.rb', line 109
def validate_session_num!(db_type)
return unless current && db_type == :embedded_db
fail InitializationError, 'Multiple sessions are not supported by Neo4j Embedded.'
end
|
Instance Method Details
#_query(*params) ⇒ Object
Same as #query but does not accept an DSL and returns the raw result from the database. Notice, it might return different values depending on which database is used, embedded or server.
76
77
78
|
# File 'lib/neo4j/session.rb', line 76
def _query(*params)
fail 'not implemented'
end
|
#auto_commit? ⇒ Boolean
35
36
37
|
# File 'lib/neo4j/session.rb', line 35
def auto_commit?
true end
|
#begin_tx ⇒ Object
40
41
42
|
# File 'lib/neo4j/session.rb', line 40
def begin_tx
fail 'not impl.'
end
|
#close ⇒ Object
8
9
10
|
# File 'lib/neo4j/session.rb', line 8
def close
self.class.unregister(self)
end
|
#db_type ⇒ :embedded_db | :server_db
31
32
33
|
# File 'lib/neo4j/session.rb', line 31
def db_type
fail 'not impl.'
end
|
Performs a cypher query. See Core::Query for more details, but basic usage looks like:
69
70
71
|
# File 'lib/neo4j/session.rb', line 69
def query(options = {})
fail 'not implemented, abstract'
end
|
#running ⇒ Object
Only for embedded database
26
27
28
|
# File 'lib/neo4j/session.rb', line 26
def running
fail 'not impl.'
end
|
#shutdown ⇒ Object
Only for embedded database
20
21
22
|
# File 'lib/neo4j/session.rb', line 20
def shutdown
fail 'not impl.'
end
|
#start ⇒ Object
Only for embedded database
14
15
16
|
# File 'lib/neo4j/session.rb', line 14
def start
fail 'not impl.'
end
|