utility/lip_filter/LIPFilter.proto

// 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.

syntax = "proto2";

package quickstep.serialization;

import "types/Type.proto";

enum LIPFilterType {
  BIT_VECTOR_EXACT_FILTER = 1;
  BLOOM_FILTER = 2;
  SINGLE_IDENTITY_HASH_FILTER = 3;
}

message LIPFilter {
  required LIPFilterType lip_filter_type = 1;

  extensions 16 to max;
}

message BitVectorExactFilter {
  extend LIPFilter {
    // All required
    optional int64 min_value = 16;
    optional int64 max_value = 17;
    optional uint64 attribute_size = 18;
    optional bool is_anti_filter = 19;
  }
}

message SingleIdentityHashFilter {
  extend LIPFilter {
    // All required
    optional uint64 filter_cardinality = 24;
    optional uint64 attribute_size = 25;
  }
}

message LIPFilterDeployment {
  message Entry {
    required uint32 lip_filter_id = 1;
    required int32 attribute_id = 2;
    required Type attribute_type = 3;
  }

  repeated Entry build_entries = 1;
  repeated Entry probe_entries = 2;
}