Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Improve Metadata Search: This requires redesign of how we store metadata. Design proposed below.
    • Fix the bug in Metadata Search Make search for tags which works only work for all the first entry and not other tags in the list
    • Support tokenized search where user can search with any word from the value
  2. Schema Search:
    • CDAP Schema for Datasets, Streams and Views should be stored as metadata and searchable through fieldname

Checklist

  •  User stories documented (Rohit/Poorna)
  •  User stories reviewed (Nitin)
  •  Design documented (Rohit/Poorna)
  •  Design reviewed (Andreas)
  •  Feature merged (Rohit)
  •  Examples and guides (Rohit)
  •  Integration tests (Rohit) 
  •  Documentation for feature (Rohit)
  •  Blog post 

User Stories: 

  1. Key Value Metadata Search
    1. User should be able to search with key-value
    metadata with the following
    1. or
    with
    1. its prefix
    :key with
  2. key-value 
    1. User should be able to search with key and part of value or its prefix
    2. User should be able to search with just value
    Individual
    1. or its prefix
    2. User should be able to search with individual words in the value 
  3. Tag Metadata Search
    1. User should be able to search with tags key and a tag value

    Example
    1. or its prefix
    2. User should be able to search with just a tag value or its prefix.
  4. Schema Search:
    1. User should be able search with fieldname or its prefix
    2. User should be able to search with fieldname or its prefix scoped just to schema 
    3. User should be able to search for all entities with a schema







Design

 

 

Search Query Examples:

  1. User stores a key-value metadata with key = "Codename" and value = "Alpha Tango Charlie" for an entity
    1. User
    should be able to search for
    1. can retrieve this entity with the following queries:
      • key-value
        1. Codename: Alpha Tango Charlie
        2. Codename: Alpha Tang*
      • key with part of value
        1. Codename: Alpha
        2. Codename: Tango
        3. Codename: Charlie
        4. Codename: Alp*
      • value
        1. Alpha Tango Charlie
        2. Alpha*
        3. Alpha Tan*
          Note:
          1. We have decided not to support searches for queries which have parts of value for example "Tango Charlie". You can either search for whole value or with prefix or single words (we plan to tokenize on whitespace) 
      • parts of value
        1. Alpha
        2. Tango
        3. Charlie
        4. Alph*
        5. Tan*
        6. Ch*
    User should be able to search tags metadata with the following or with its prefix:tags key and a tag value
  2. a tag value
    Example:
    User tags an entity with the following tags "Tag1, Tag22"
    • User should be able to search for can retrieve this entity with the following queries:
      • tag key and a tag value:
        1. tags: Tag1
        2. tags: Tag*
      • a tag value
        1. tag22 
        2. tag2*
  3. User should be able search for entities (datasets, streams, views) through field-names in schema with the following or with its prefix:
  4. fieldname
  5. fieldname scoped with schema - this should limit the search to just schema fields and not other metadata
  6. User should be able to search for all entities with which has a schema
    Example:

    A dataset has the following schema: 

    Code Block
    titleNested Schema
    {
      "EmpName": "String",
      "EmpContact": {
        "EmpTel": "Integer",
        "EmpAddr": "String"
      }
    }

    User

    should be able to search for

    can retrieve this dataset entity with the following queries:

    • fieldname:
      1. EmpName
      2. EmpContact
      3. EmpTel 
      4. EmpAddr
      5. Emp*
    • fieldname scoped to schema:
      1. schema: EmpName
      2. schema: EmpContact
      3. schema: EmpTel
      4. schema: EmpAddr 
      5. schema: Emp*
    • search for all entities with a schema
      1. schema:* This will return this dataset entity and also all the other entities which have schema stored as their metadata

    Note:
      • We don't plan to support schema searches with fieldType. If a user  searched with a query which is not scoped with schema by default it will search for schema fields besides the normal key-value and tags.
        Open questions:
        • What if an entity has multiple schema (ex: transform which has input and output schema)
          • Maybe We can index its fields with input and output schema and we expect an user to specify whether they are looking for something in input schema or output schema. 
        • What about entities which have more than one schema?
          • Maybe we can store them either as input output with identifier.
        • How will an user search for a fieldName across input and output schema ?
          • One way is to besides indexing the fields as input and output schema we also index every field as just schema so that we can perform such queries. 

Design

...

Storage:

We are going to use the IndexedTable which we are using currently too. In the new storage design we will have two rows: 

...