Spear
▼
Project version
v1.4.1
v1.4.0
v1.3.2
v1.3.1
v1.3.0
v1.2.1
v1.2.0
v1.1.0
v1.0.2
v1.0.1
v1.0.0
v0.11.0
v0.10.0
v0.10.0-rc.1
v0.9.1
v0.9.0
v0.8.1
v0.8.0
v0.7.0
v0.6.1
v0.6.0
v0.5.0
v0.4.0
v0.3.0
v0.2.1
v0.2.0
v0.1.4
v0.1.3
v0.1.2
v0.1.1
v0.1.0
Pages
Modules
API Reference
Modules
Changelog
1.4.1 - 2024-08-03
1.4.0 - 2024-02-02
1.3.2 - 2023-06-12
1.3.1 - 2023-04-04
1.3.0 - 2022-12-09
1.2.1 - 2022-11-14
1.2.0 - 2022-11-02
1.1.0 - 2022-07-08
1.0.2 - 2022-06-02
1.0.1 - 2022-05-26
1.0.0 - 2022-05-11
0.11.0 - 2021-11-04
0.10.0 - 2021-08-30
0.9.1 - 2021-06-01
0.9.0 - 2021-04-29
0.8.1 - 2021-04-27
0.8.0 - 2021-04-26
0.7.0 - 2021-04-24
0.6.1 - 2021-04-23
0.6.0 - 2021-04-21
0.5.0 - 2021-04-19
0.4.0 - 2021-04-19
0.3.0 - 2021-04-18
0.2.1 - 2021-04-17
0.2.0 - 2021-04-17
0.1.4 - 2021-04-16
0.1.3 - 2021-04-15
0.1.2 - 2021-04-14
0.1.1 - 2021-04-14
0.1.0 - 2021-04-12
Guides
Writing Events
Enumeration Characteristics
Blocking
Increasing append throughput with Spear.append_batch/5
Example: use Streams and Tasks with Spear.append_batch/5
Streams
Link Resolution
Security
Setting up an EventStoreDB for security
Using custom TLS certificates with Spear
Using TLS certificates signed by a public CA
Credentials
Access control lists
Pooling
Spear
Sections
Streams
Connections
Record interfaces
Summary
Utility Functions
cancel_subscription/3
meta_stream/1
park_stream/2
parse_stamp/1
ping/2
request/5
scavenge_stream/1
set_global_acl/4
Streams
append/4
append_batch/5
append_batch_stream/2
delete_stream/3
get_stream_metadata/3
read_stream/3
set_stream_metadata/4
stream!/3
subscribe/4
Users
change_user_password/5
create_user/6
delete_user/3
disable_user/3
enable_user/3
reset_user_password/4
update_user/6
user_details/3
Operations
merge_indexes/2
resign_node/2
restart_persistent_subscriptions/2
set_node_priority/3
shutdown/2
start_scavenge/2
stop_scavenge/3
Persistent Subscriptions
ack/3
connect_to_persistent_subscription/5
create_persistent_subscription/5
delete_persistent_subscription/4
get_persistent_subscription_info/4
list_persistent_subscriptions/2
nack/4
replay_parked_messages/4
restart_persistent_subscription_subsystem/2
update_persistent_subscription/5
Gossip
cluster_info/2
Monitoring
subscribe_to_stats/3
Server Features
get_server_version/2
get_supported_rpcs/2
Spear.Client
Sections
Configuration
Examples
Summary
Callbacks
ack/2
append/2
append/3
append_batch/3
append_batch/4
append_batch_stream/1
cancel_subscription/1
cancel_subscription/2
change_user_password/3
change_user_password/4
cluster_info/0
cluster_info/1
connect_to_persistent_subscription/3
connect_to_persistent_subscription/4
create_persistent_subscription/3
create_persistent_subscription/4
create_user/4
create_user/5
delete_persistent_subscription/2
delete_persistent_subscription/3
delete_stream/1
delete_stream/2
delete_user/1
delete_user/2
disable_user/1
disable_user/2
enable_user/1
enable_user/2
get_persistent_subscription_info/2
get_persistent_subscription_info/3
get_server_version/0
get_server_version/1
get_stream_metadata/1
get_stream_metadata/2
get_supported_rpcs/0
get_supported_rpcs/1
list_persistent_subscriptions/0
list_persistent_subscriptions/1
merge_indexes/0
merge_indexes/1
nack/2
nack/3
ping/0
ping/1
read_stream/1
read_stream/2
replay_parked_messages/2
replay_parked_messages/3
reset_user_password/2
reset_user_password/3
resign_node/0
resign_node/1
restart_persistent_subscription_subsystem/0
restart_persistent_subscription_subsystem/1
restart_persistent_subscriptions/0
restart_persistent_subscriptions/1
set_global_acl/2
set_global_acl/3
set_node_priority/1
set_node_priority/2
set_stream_metadata/2
set_stream_metadata/3
shutdown/0
shutdown/1
start_link/1
start_scavenge/0
start_scavenge/1
stop_scavenge/1
stop_scavenge/2
stream!/1
stream!/2
subscribe/2
subscribe/3
subscribe_to_stats/1
subscribe_to_stats/2
update_persistent_subscription/3
update_persistent_subscription/4
update_user/4
update_user/5
user_details/1
user_details/2
Spear.Connection
Sections
Configuration
TLS/SSL configuration and credentials
Keep-alive
Examples
Summary
Types
t/0
Functions
read_api?/2
read_apis/0
start_link/1
Spear.Filter
Sections
Regular expressions
Checkpoints
Checkpoint Interval
Summary
Types
t/0
Functions
checkpoint_after/2
exclude_system_events/0
sigil_F/2
sigil_f/2
Spear.PersistentSubscription.Info
Summary
Types
t/0
Spear.PersistentSubscription.Info.ConnectionInfo
Summary
Types
t/0
Spear.PersistentSubscription.Info.ConnectionInfo.Measurement
Summary
Types
t/0
Structures and Types
Spear.Acl
Summary
Types
t/0
Functions
admins_only/0
allow_all/0
to_map/1
Spear.BatchAppendResult
Summary
Types
t/0
Spear.ClusterMember
Summary
Types
state/0
t/0
Functions
from_member_info/1
Spear.Connection.Configuration
Sections
Options
Summary
Types
t/0
Functions
new/1
Spear.Event
Summary
Types
t/0
Functions
from_read_response/2
id/1
new/3
revision/1
to_checkpoint/1
to_proposed_message/3
uuid_v4/0
uuid_v4/1
Spear.ExpectationViolation
Sections
Expectations
Summary
Types
t/0
Spear.Filter.Checkpoint
Summary
Types
t/0
Spear.PersistentSubscription
Summary
Types
nack_action/0
t/0
Functions
map_update_stream_option/2
Spear.PersistentSubscription.Settings
Summary
Types
consumer_strategy/0
t/0
Spear.Position
Summary
Types
t/0
Spear.Scavenge
Summary
Types
t/0
Spear.StreamMetadata
Summary
Types
t/0
Functions
to_map/1
Spear.SupportedRpc
Summary
Types
t/0
Spear.User
Summary
Types
t/0
Functions
from_details_resp/1
Record interfaces
Spear.Records.Google
Summary
Functions
duration/2
empty/0
timestamp/1
Spear.Records.Gossip
Summary
Functions
cluster_info/1
cluster_info/2
end_point/1
end_point/2
member_info/1
member_info/2
service/0
service_module/0
Spear.Records.Monitoring
Summary
Functions
service/0
service_module/0
stats_req/1
stats_req/2
stats_resp/1
stats_resp/2
Spear.Records.Operations
Summary
Functions
scavenge_resp/1
scavenge_resp/2
service/0
service_module/0
set_node_priority_req/1
set_node_priority_req/2
start_scavenge_req/1
start_scavenge_req/2
start_scavenge_req_options/1
start_scavenge_req_options/2
stop_scavenge_req/1
stop_scavenge_req/2
stop_scavenge_req_options/1
stop_scavenge_req_options/2
Spear.Records.Persistent
Summary
Functions
create_req/1
create_req/2
create_req_all_options/1
create_req_all_options/2
create_req_all_options_filter_options/1
create_req_all_options_filter_options/2
create_req_all_options_filter_options_expression/1
create_req_all_options_filter_options_expression/2
create_req_options/1
create_req_options/2
create_req_position/1
create_req_position/2
create_req_settings/1
create_req_settings/2
create_req_stream_options/1
create_req_stream_options/2
create_resp/1
create_resp/2
delete_req/1
delete_req/2
delete_req_options/1
delete_req_options/2
delete_resp/1
delete_resp/2
get_info_req/1
get_info_req/2
get_info_req_options/1
get_info_req_options/2
get_info_resp/1
get_info_resp/2
list_req/1
list_req/2
list_req_options/1
list_req_options/2
list_req_stream_option/1
list_req_stream_option/2
list_resp/1
list_resp/2
read_req/1
read_req/2
read_req_ack/1
read_req_ack/2
read_req_nack/1
read_req_nack/2
read_req_options/1
read_req_options/2
read_req_options_uuid_option/1
read_req_options_uuid_option/2
read_resp/1
read_resp/2
read_resp_read_event/1
read_resp_read_event/2
read_resp_read_event_recorded_event/1
read_resp_read_event_recorded_event/2
read_resp_subscription_confirmation/1
read_resp_subscription_confirmation/2
replay_parked_req/1
replay_parked_req/2
replay_parked_req_options/1
replay_parked_req_options/2
replay_parked_resp/1
replay_parked_resp/2
service/0
service_module/0
subscription_info/1
subscription_info/2
subscription_info_connection_info/1
subscription_info_connection_info/2
subscription_info_measurement/1
subscription_info_measurement/2
update_req/1
update_req/2
update_req_all_options/1
update_req_all_options/2
update_req_options/1
update_req_options/2
update_req_position/1
update_req_position/2
update_req_settings/1
update_req_settings/2
update_req_stream_options/1
update_req_stream_options/2
update_resp/1
update_resp/2
Spear.Records.Projections
Summary
Functions
create_req/1
create_req/2
create_req_options/1
create_req_options/2
create_req_options_continuous/1
create_req_options_continuous/2
create_req_options_transient/1
create_req_options_transient/2
create_resp/1
create_resp/2
delete_req/1
delete_req/2
delete_req_options/1
delete_req_options/2
delete_resp/1
delete_resp/2
disable_req/1
disable_req/2
disable_req_options/1
disable_req_options/2
disable_resp/1
disable_resp/2
enable_req/1
enable_req/2
enable_req_options/1
enable_req_options/2
enable_resp/1
enable_resp/2
reset_req/1
reset_req/2
reset_req_options/1
reset_req_options/2
reset_resp/1
reset_resp/2
result_req/1
result_req/2
result_req_options/1
result_req_options/2
result_resp/1
result_resp/2
service/0
service_module/0
state_req/1
state_req/2
state_req_options/1
state_req_options/2
state_resp/1
state_resp/2
statistics_req/1
statistics_req/2
statistics_req_options/1
statistics_req_options/2
statistics_resp/1
statistics_resp/2
statistics_resp_details/1
statistics_resp_details/2
update_req/1
update_req/2
update_req_options/1
update_req_options/2
update_resp/1
update_resp/2
Spear.Records.ServerFeatures
Summary
Functions
service/0
service_module/0
supported_method/1
supported_method/2
supported_methods/1
supported_methods/2
Spear.Records.Shared
Summary
Functions
access_denied/1
access_denied/2
all_stream_position/1
all_stream_position/2
bad_request/1
bad_request/2
empty/1
empty/2
invalid_transaction/1
invalid_transaction/2
maximum_append_size_exceeded/1
maximum_append_size_exceeded/2
service/0
service_module/0
stream_deleted/1
stream_deleted/2
stream_identifier/1
stream_identifier/2
timeout/1
timeout/2
unknown/1
unknown/2
uuid/1
uuid/2
uuid_structured/1
uuid_structured/2
wrong_expected_version/1
wrong_expected_version/2
Spear.Records.Status
Summary
Functions
service/0
service_module/0
status/1
status/2
Spear.Records.Streams
Summary
Functions
append_req/1
append_req/2
append_req_options/1
append_req_options/2
append_req_proposed_message/1
append_req_proposed_message/2
append_resp/1
append_resp/2
append_resp_position/1
append_resp_position/2
append_resp_success/1
append_resp_success/2
append_resp_wrong_expected_version/1
append_resp_wrong_expected_version/2
batch_append_req/1
batch_append_req/2
batch_append_req_options/1
batch_append_req_options/2
batch_append_req_proposed_message/1
batch_append_req_proposed_message/2
batch_append_resp/1
batch_append_resp/2
batch_append_resp_success/1
batch_append_resp_success/2
delete_req/1
delete_req/2
delete_req_options/1
delete_req_options/2
delete_resp/1
delete_resp/2
delete_resp_position/1
delete_resp_position/2
read_req/1
read_req/2
read_req_options/1
read_req_options/2
read_req_options_all_options/1
read_req_options_all_options/2
read_req_options_control_option/1
read_req_options_control_option/2
read_req_options_filter_options/1
read_req_options_filter_options/2
read_req_options_filter_options_expression/1
read_req_options_filter_options_expression/2
read_req_options_position/1
read_req_options_position/2
read_req_options_stream_options/1
read_req_options_stream_options/2
read_req_options_subscription_options/1
read_req_options_subscription_options/2
read_req_options_uuid_option/1
read_req_options_uuid_option/2
read_resp/1
read_resp/2
read_resp_caught_up/1
read_resp_caught_up/2
read_resp_checkpoint/1
read_resp_checkpoint/2
read_resp_fell_behind/1
read_resp_fell_behind/2
read_resp_read_event/1
read_resp_read_event/2
read_resp_read_event_recorded_event/1
read_resp_read_event_recorded_event/2
read_resp_stream_not_found/1
read_resp_stream_not_found/2
read_resp_subscription_confirmation/1
read_resp_subscription_confirmation/2
service/0
service_module/0
tombstone_req/1
tombstone_req/2
tombstone_req_options/1
tombstone_req_options/2
tombstone_resp/1
tombstone_resp/2
tombstone_resp_position/1
tombstone_resp_position/2
Spear.Records.Users
Summary
Functions
change_password_req/1
change_password_req/2
change_password_req_options/1
change_password_req_options/2
change_password_resp/1
change_password_resp/2
create_req/1
create_req/2
create_req_options/1
create_req_options/2
create_resp/1
create_resp/2
delete_req/1
delete_req/2
delete_req_options/1
delete_req_options/2
delete_resp/1
delete_resp/2
details_req/1
details_req/2
details_req_options/1
details_req_options/2
details_resp/1
details_resp/2
details_resp_user_details/1
details_resp_user_details/2
details_resp_user_details_date_time/1
details_resp_user_details_date_time/2
disable_req/1
disable_req/2
disable_req_options/1
disable_req_options/2
disable_resp/1
disable_resp/2
enable_req/1
enable_req/2
enable_req_options/1
enable_req_options/2
enable_resp/1
enable_resp/2
reset_password_req/1
reset_password_req/2
reset_password_req_options/1
reset_password_req_options/2
reset_password_resp/1
reset_password_resp/2
service/0
service_module/0
update_req/1
update_req/2
update_req_options/1
update_req_options/2
update_resp/1
update_resp/2
Search documentation of Spear
Settings
View Source
Spear.Records.Google
(Spear v1.4.1)
A record-like wrapper around google protobufs
Summary
Functions
duration(seconds, nanos)
empty()
timestamp(datetime)
Functions
Link to this function
duration(seconds, nanos)
View Source
Link to this macro
empty()
View Source
(macro)
Link to this function
timestamp(datetime)
View Source
×