Skip to content

Projections

Projections Mixin.

Projections

Bases: ClientBase

Handles Projections Operations.

Source code in src/eventstore_grpc/client/projections.py 
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
class Projections(ClientBase):
    """Handles Projections Operations."""

    def create_continuous_projection(
        self, name: str, query: str, track_emitted_streams: bool = False, **kwargs
    ) -> projections_pb2.CreateResp:
        """Creates a continuous projection."""
        stub = projections_pb2_grpc.ProjectionsStub(self.channel)
        result = projections.create_continuous_projection(
            stub,
            name=name,
            query=query,
            track_emitted_streams=track_emitted_streams,
            **kwargs
        )
        return result

    def create_one_time_projection(
        self, query: str, track_emitted_streams: bool = False, **kwargs
    ) -> projections_pb2.CreateResp:
        """Creates a one time projection."""
        stub = projections_pb2_grpc.ProjectionsStub(self.channel)
        result = projections.create_one_time_projection(
            stub, query=query, track_emitted_streams=track_emitted_streams, **kwargs
        )
        return result

    def create_transient_projection(
        self, name: str, query: str, **kwargs
    ) -> projections_pb2.CreateResp:
        """Creates a transient projection."""
        stub = projections_pb2_grpc.ProjectionsStub(self.channel)
        result = projections.create_transient_projection(
            stub, name=name, query=query, **kwargs
        )
        return result

    def delete_projection(
        self,
        name: str,
        delete_emitted_streams: bool = True,
        delete_state_stream: bool = True,
        delete_checkpoint_stream: bool = True,
        **kwargs
    ) -> projections_pb2.DeleteResp:
        """Deletes a projection."""
        stub = projections_pb2_grpc.ProjectionsStub(self.channel)
        result = projections.delete_projection(
            stub,
            name=name,
            delete_emitted_streams=delete_emitted_streams,
            delete_state_stream=delete_state_stream,
            delete_checkpoint_stream=delete_checkpoint_stream,
            **kwargs
        )
        return result

    def disable_projection(
        self, name: str, write_checkpoint: bool = True, **kwargs
    ) -> projections_pb2.DisableResp:
        """Disables a projection."""
        stub = projections_pb2_grpc.ProjectionsStub(self.channel)
        result = projections.disable_projection(
            stub, name=name, write_checkpoint=write_checkpoint, **kwargs
        )
        return result

    def enable_projection(self, name: str, **kwargs) -> projections_pb2.EnableResp:
        """Enables a projection."""
        stub = projections_pb2_grpc.ProjectionsStub(self.channel)
        result = projections.enable_projection(stub, name=name, **kwargs)
        return result

    def list_continuous_projections(
        self, **kwargs
    ) -> Iterable[projections_pb2.StatisticsResp]:
        """Lists continuous projections."""
        stub = projections_pb2_grpc.ProjectionsStub(self.channel)
        result = projections.list_continuous_projections(stub, **kwargs)
        return result

    def list_one_time_projections(
        self, **kwargs
    ) -> Iterable[projections_pb2.StatisticsResp]:
        """Lists one time projections."""
        stub = projections_pb2_grpc.ProjectionsStub(self.channel)
        result = projections.list_one_time_projections(stub, **kwargs)
        return result

    def list_transient_projections(
        self, **kwargs
    ) -> Iterable[projections_pb2.StatisticsResp]:
        """List transient projections."""
        stub = projections_pb2_grpc.ProjectionsStub(self.channel)
        result = projections.list_transient_projections(stub, **kwargs)
        return result

    def reset_projection(
        self, name: str, write_checkpoint: bool = True, **kwargs
    ) -> projections_pb2.ResetResp:
        """Resets a projection."""
        stub = projections_pb2_grpc.ProjectionsStub(self.channel)
        result = projections.reset_projection(
            stub, name=name, write_checkpoint=write_checkpoint, **kwargs
        )
        return result

    def restart_projections_subsystem(self, **kwargs) -> shared_pb2.Empty:
        """Restarts projections subsystem."""
        stub = projections_pb2_grpc.ProjectionsStub(self.channel)
        result = projections.restart_projections_subsystem(stub, **kwargs)
        return result

    def get_projection_result(
        self, name: str, from_partition: Optional[str] = None, **kwargs
    ) -> projections_pb2.ResultResp:
        """Gets a projection result."""
        stub = projections_pb2_grpc.ProjectionsStub(self.channel)
        result = projections.get_projection_result(
            stub, name=name, from_partition=from_partition, **kwargs
        )
        return result

    def get_projection_state(self, name: str, **kwargs) -> projections_pb2.StateResp:
        """Gets a projection's state."""
        stub = projections_pb2_grpc.ProjectionsStub(self.channel)
        result = projections.get_projection_state(stub, name=name, **kwargs)
        return result

    def get_projection_statistics(
        self, name: str, **kwargs
    ) -> Iterable[projections_pb2.StatisticsResp]:
        """Gets projection statistics."""
        stub = projections_pb2_grpc.ProjectionsStub(self.channel)
        result = projections.get_projection_statistics(stub, name=name, **kwargs)
        return result

    def update_projection(
        self,
        name: str,
        query: str,
        track_emitted_streams: Optional[bool] = None,
        **kwargs
    ) -> projections_pb2.UpdateResp:
        """Updates a projection."""
        stub = projections_pb2_grpc.ProjectionsStub(self.channel)
        result = projections.update_projection(
            stub,
            name=name,
            query=query,
            track_emitted_streams=track_emitted_streams,
            **kwargs
        )
        return result

create_continuous_projection(name, query, track_emitted_streams=False, **kwargs)

Creates a continuous projection.

Source code in src/eventstore_grpc/client/projections.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
def create_continuous_projection(
    self, name: str, query: str, track_emitted_streams: bool = False, **kwargs
) -> projections_pb2.CreateResp:
    """Creates a continuous projection."""
    stub = projections_pb2_grpc.ProjectionsStub(self.channel)
    result = projections.create_continuous_projection(
        stub,
        name=name,
        query=query,
        track_emitted_streams=track_emitted_streams,
        **kwargs
    )
    return result

create_one_time_projection(query, track_emitted_streams=False, **kwargs)

Creates a one time projection.

Source code in src/eventstore_grpc/client/projections.py 
29
30
31
32
33
34
35
36
37
def create_one_time_projection(
    self, query: str, track_emitted_streams: bool = False, **kwargs
) -> projections_pb2.CreateResp:
    """Creates a one time projection."""
    stub = projections_pb2_grpc.ProjectionsStub(self.channel)
    result = projections.create_one_time_projection(
        stub, query=query, track_emitted_streams=track_emitted_streams, **kwargs
    )
    return result

create_transient_projection(name, query, **kwargs)

Creates a transient projection.

Source code in src/eventstore_grpc/client/projections.py 
39
40
41
42
43
44
45
46
47
def create_transient_projection(
    self, name: str, query: str, **kwargs
) -> projections_pb2.CreateResp:
    """Creates a transient projection."""
    stub = projections_pb2_grpc.ProjectionsStub(self.channel)
    result = projections.create_transient_projection(
        stub, name=name, query=query, **kwargs
    )
    return result

delete_projection(name, delete_emitted_streams=True, delete_state_stream=True, delete_checkpoint_stream=True, **kwargs)

Deletes a projection.

Source code in src/eventstore_grpc/client/projections.py 
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
def delete_projection(
    self,
    name: str,
    delete_emitted_streams: bool = True,
    delete_state_stream: bool = True,
    delete_checkpoint_stream: bool = True,
    **kwargs
) -> projections_pb2.DeleteResp:
    """Deletes a projection."""
    stub = projections_pb2_grpc.ProjectionsStub(self.channel)
    result = projections.delete_projection(
        stub,
        name=name,
        delete_emitted_streams=delete_emitted_streams,
        delete_state_stream=delete_state_stream,
        delete_checkpoint_stream=delete_checkpoint_stream,
        **kwargs
    )
    return result

disable_projection(name, write_checkpoint=True, **kwargs)

Disables a projection.

Source code in src/eventstore_grpc/client/projections.py 
69
70
71
72
73
74
75
76
77
def disable_projection(
    self, name: str, write_checkpoint: bool = True, **kwargs
) -> projections_pb2.DisableResp:
    """Disables a projection."""
    stub = projections_pb2_grpc.ProjectionsStub(self.channel)
    result = projections.disable_projection(
        stub, name=name, write_checkpoint=write_checkpoint, **kwargs
    )
    return result

enable_projection(name, **kwargs)

Enables a projection.

Source code in src/eventstore_grpc/client/projections.py 
79
80
81
82
83
def enable_projection(self, name: str, **kwargs) -> projections_pb2.EnableResp:
    """Enables a projection."""
    stub = projections_pb2_grpc.ProjectionsStub(self.channel)
    result = projections.enable_projection(stub, name=name, **kwargs)
    return result

get_projection_result(name, from_partition=None, **kwargs)

Gets a projection result.

Source code in src/eventstore_grpc/client/projections.py 
125
126
127
128
129
130
131
132
133
def get_projection_result(
    self, name: str, from_partition: Optional[str] = None, **kwargs
) -> projections_pb2.ResultResp:
    """Gets a projection result."""
    stub = projections_pb2_grpc.ProjectionsStub(self.channel)
    result = projections.get_projection_result(
        stub, name=name, from_partition=from_partition, **kwargs
    )
    return result

get_projection_state(name, **kwargs)

Gets a projection's state.

Source code in src/eventstore_grpc/client/projections.py 
135
136
137
138
139
def get_projection_state(self, name: str, **kwargs) -> projections_pb2.StateResp:
    """Gets a projection's state."""
    stub = projections_pb2_grpc.ProjectionsStub(self.channel)
    result = projections.get_projection_state(stub, name=name, **kwargs)
    return result

get_projection_statistics(name, **kwargs)

Gets projection statistics.

Source code in src/eventstore_grpc/client/projections.py 
141
142
143
144
145
146
147
def get_projection_statistics(
    self, name: str, **kwargs
) -> Iterable[projections_pb2.StatisticsResp]:
    """Gets projection statistics."""
    stub = projections_pb2_grpc.ProjectionsStub(self.channel)
    result = projections.get_projection_statistics(stub, name=name, **kwargs)
    return result

list_continuous_projections(**kwargs)

Lists continuous projections.

Source code in src/eventstore_grpc/client/projections.py 
85
86
87
88
89
90
91
def list_continuous_projections(
    self, **kwargs
) -> Iterable[projections_pb2.StatisticsResp]:
    """Lists continuous projections."""
    stub = projections_pb2_grpc.ProjectionsStub(self.channel)
    result = projections.list_continuous_projections(stub, **kwargs)
    return result

list_one_time_projections(**kwargs)

Lists one time projections.

Source code in src/eventstore_grpc/client/projections.py 
93
94
95
96
97
98
99
def list_one_time_projections(
    self, **kwargs
) -> Iterable[projections_pb2.StatisticsResp]:
    """Lists one time projections."""
    stub = projections_pb2_grpc.ProjectionsStub(self.channel)
    result = projections.list_one_time_projections(stub, **kwargs)
    return result

list_transient_projections(**kwargs)

List transient projections.

Source code in src/eventstore_grpc/client/projections.py 
101
102
103
104
105
106
107
def list_transient_projections(
    self, **kwargs
) -> Iterable[projections_pb2.StatisticsResp]:
    """List transient projections."""
    stub = projections_pb2_grpc.ProjectionsStub(self.channel)
    result = projections.list_transient_projections(stub, **kwargs)
    return result

reset_projection(name, write_checkpoint=True, **kwargs)

Resets a projection.

Source code in src/eventstore_grpc/client/projections.py 
109
110
111
112
113
114
115
116
117
def reset_projection(
    self, name: str, write_checkpoint: bool = True, **kwargs
) -> projections_pb2.ResetResp:
    """Resets a projection."""
    stub = projections_pb2_grpc.ProjectionsStub(self.channel)
    result = projections.reset_projection(
        stub, name=name, write_checkpoint=write_checkpoint, **kwargs
    )
    return result

restart_projections_subsystem(**kwargs)

Restarts projections subsystem.

Source code in src/eventstore_grpc/client/projections.py 
119
120
121
122
123
def restart_projections_subsystem(self, **kwargs) -> shared_pb2.Empty:
    """Restarts projections subsystem."""
    stub = projections_pb2_grpc.ProjectionsStub(self.channel)
    result = projections.restart_projections_subsystem(stub, **kwargs)
    return result

update_projection(name, query, track_emitted_streams=None, **kwargs)

Updates a projection.

Source code in src/eventstore_grpc/client/projections.py 
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
def update_projection(
    self,
    name: str,
    query: str,
    track_emitted_streams: Optional[bool] = None,
    **kwargs
) -> projections_pb2.UpdateResp:
    """Updates a projection."""
    stub = projections_pb2_grpc.ProjectionsStub(self.channel)
    result = projections.update_projection(
        stub,
        name=name,
        query=query,
        track_emitted_streams=track_emitted_streams,
        **kwargs
    )
    return result