schema.json

{
  "description": "COmanage Match Database Schema File",
  "format": "1",
  "license": "Apache 2, See NOTICE and LICENSE files",

  "XXX": [
    "remove schema.xml; adodb can't be removed until inline adodb calls are rewritten",
    "review https://www.doctrine-project.org/projects/doctrine-dbal/en/2.9/reference/known-vendor-issues.html#known-vendor-issues"
  ],

  "columnLibrary": {
    "comment": "columns with names matching those defined here will by default inherit these properties",

    "columns": {
      "attribute_map_id": { "type": "integer", "foreignkey": { "table": "attribute_maps", "column": "id" } },
      "description": { "type": "string", "size": 128 },
      "id": { "type": "integer", "autoincrement": true, "primarykey": true },
      "matchgrid_id": { "type": "integer", "foreignkey": { "table": "matchgrids", "column": "id" }, "notnull": true },
      "name": { "type": "string", "size": 64, "notnull": true },
      "status": { "type": "string", "size": 2 }
    }
  },
  
  "tables": {
    "meta": {
      "columns": {
        "id": {},
        "upgrade_version": { "type": "string", "size": 16 }
      },
      "timestamps": false,
      "changelog": false
    },
    
    "matchgrids": {
      "columns": {
        "id": {},
        "description": {},
        "table_name": { "type": "string", "size": 128, "notnull": true },
        "status": {}
      },
      "indexes": {
        "matchgrids_i1": {
          "columns": [ "table_name" ],
"XXX": "changelog obviates unique keys?",
          "unique": true
        }
      },
      "changelog": false
    },
    
    "endpoints": {
      "columns": {
        "id": {},
        "matchgrid_id": {},
        "description": {},
        "url": { "type": "string", "size": 256 },
        "username": { "type": "string", "size": 128 },
        "password": { "type": "string", "size": 256 }
      },
      "indexes": {
        "endpoints_i1": {
          "columns": [ "matchgrid_id" ]
        }
      },
      "changelog": false
    },
    
    "matchgrid_settings": {
      "columns": {
        "id": {},
        "matchgrid_id": {},
        "referenceid_method": { "type": "string", "size": 2 },
        "referenceid_start": { "type": "integer" },
        "referenceid_prefix": { "type": "string", "size": 32 },
        "notification_email": { "type": "string", "size": 80 },
        "resolution_notification_endpoint_id": { "type": "integer", "foreignkey": { "table": "endpoints", "column": "id" } }
      },
      "indexes": {
        "matchgrid_settings_i1": {
          "columns": [ "matchgrid_id" ]
        },
        "matchgrid_settings_i2": {
          "columns": [ "resolution_notification_endpoint_id" ]
        }
      },
      "changelog": false
    },
    
    "permissions": {
      "columns": {
        "id": {},
        "matchgrid_id": { "notnull": false },
        "username": {
          "XXX": "we don't currently define username anywhere, ie there is no users table",
          "type": "string", "size": 320
        },
        "permission": { "type": "string", "size": 2 }
      },
      "indexes": {
        "permissions_i1": {
          "columns": [ "matchgrid_id" ]
        }
      },
      "changelog": false
    },
    
    "attribute_maps": {
      "columns": {
        "id": {},
        "matchgrid_id": {},
        "name": {},
        "description": {}
      },
      "indexes": {
        "attribute_maps_i1": {
          "columns": [ "matchgrid_id" ]
        }
      },
      "changelog": false
    },
    
    "attribute_mappings": {
      "columns": {
        "id": {},
        "attribute_map_id": {},
        "query": { "type": "string", "size": 80 },
        "value": { "type": "string", "size": 80 }
      },
      "indexes": {
        "attribute_mappings_i1": {
          "columns": [ "attribute_map_id" ]
        },
        "attribute_mappings_i2": {
          "columns": [ "query" ]
        }
      },
      "changelog": false
    },
    
    "attribute_groups": {
      "columns": {
        "id": {},
        "matchgrid_id": {},
        "name": {}
      },
      "indexes": {
        "attribute_groups_i1": {
          "columns": [ "matchgrid_id" ]
        }
      },
      "changelog": false
    },
    
    "attributes": {
      "columns": {
        "id": {},
        "matchgrid_id": {},
        "attribute_group_id": { "type": "integer", "foreignkey": { "table": "attribute_groups", "column": "id" } },
        "name": {},
        "description": {},
        "api_name": { "type": "string", "size": 128 },
        "index_display": { "type": "boolean" },
        "alphanumeric": { "type": "boolean" },
        "case_sensitive": { "type": "boolean" },
        "null_equivalents": { "type": "boolean" },
        "search_distance": { "type": "integer" },
        "search_exact": { "type": "boolean" },
        "search_substr_from": { "type": "integer" },
        "search_substr_for": { "type": "integer" },
        "attribute_map_id": {}
      },
      "indexes": {
        "attributes_i1": {
          "columns": [ "matchgrid_id" ]
        },
        "attributes_i2": {
          "comment": "We don't really need this index but DBAL will create it anyway, with a random name",
          "columns": [ "attribute_group_id" ]
        }
      },
      "changelog": false
    },
    
    "rules": {
      "columns": {
        "id": {},
        "matchgrid_id": {},
        "name": {},
        "description": {},
        "confidence_mode": { "type": "string", "size": 2 },
        "ordr": { "type": "integer" }
      },
      "indexes": {
        "rules_i1": {
          "columns": [ "matchgrid_id" ]
        }
      },
      "changelog": false
    },
    
    "rule_attributes": {
      "columns": {
        "id": {},
        "rule_id": { "type": "integer", "foreignkey": { "table": "rules", "column": "id" } },
        "attribute_id": { "type": "integer", "foreignkey": { "table": "attributes", "column": "id" } },
        "crosscheck_attribute_id": { "type": "integer", "foreignkey": { "table": "attributes", "column": "id" } },
        "search_type": { "type": "string", "size": 2 },
        "required": { "type": "boolean" },
        "match_empty": { "type": "boolean" }
      },
      "indexes": {
        "rule_attributes_i1": {
          "columns": [ "rule_id" ]
        },
        "rule_attributes_i2": {
          "comment": "We don't really need this index but DBAL will create it anyway, with a random name",
          "columns": [ "attribute_id" ]
        },
        "rule_attributes_i3": {
          "comment": "We don't really need this index but DBAL will create it anyway, with a random name",
          "columns": [ "crosscheck_attribute_id" ]
        }
      },
      "changelog": false
    },
    
    "systems_of_record": {
      "columns": {
        "id": {},
        "matchgrid_id": {},
        "label": { "type": "string", "size": 64 },
        "trust_mode": { "type": "string", "size": 2 },
        "resolution_mode": { "type": "string", "size": 2 },
        "notification_email": { "type": "string", "size": 80 }
      },
      "indexes": {
        "systems_of_record_i1": {
          "columns": [ "matchgrid_id" ]
        }
      },
      "changelog": false
    },
    
    "api_users": {
      "columns": {
        "id": {},
        "matchgrid_id": { "notnull": false },
        "system_of_record_id": { "type": "integer", "foreignkey": { "table": "systems_of_record", "column": "id" } },
        "username": { "type": "string", "size": 128 },
        "password": { "type": "string", "size": 255 }
      },
      "indexes": {
        "api_users_i1": {
          "columns": [ "matchgrid_id" ]
        },
        "api_users_i2": {
          "columns": [ "username" ]
        },
        "api_users_i3": {
          "comment": "We don't really need this index but DBAL will create it anyway, with a random name",
          "columns": [ "system_of_record_id" ]
        }
      },
      "changelog": false
    },

    "matchgrid_history_records": {
      "columns": {
        "id": {},
        "matchgrid_id": {},
        "sor": { "type": "string", "size": 64 },
        "sorid": { "type": "string", "size": 64 },
        "action": { "type": "string", "size": 4 },
        "comment": { "type": "string", "size": 256 },
        "remote_ip": { "type": "string", "size": 80 },
        "actor_identifier": { "type": "string", "size": 256 }
      },
      "indexes": {
        "matchgrid_history_records_i1": {
          "columns": [ "matchgrid_id", "sor", "sorid" ]
        }
      },
      "changelog": false
    }
  },

  "drop-tables":[
    {
"XXX": "a list of tables to manually drop, not yet implemented"
    }
  ]
}