Safe Haskell	Safe-Inferred
Language	Haskell2010

Convex.Schema.Parser

Synopsis

parseSchema :: String -> IO (Either ParseError ParsedFile)
data ParsedFile = ParsedFile {
- parsedConstants :: Map String ConvexType
- parsedSchema :: Schema
}
newtype Schema = Schema {
- getTables :: [Table]
}
data Table = Table {
- tableName :: String
- tableFields :: [Field]
- tableIndexes :: [Index]
}
data Index = Index {
- indexName :: String
- indexFields :: [String]
}
data Field = Field {
- fieldName :: String
- fieldType :: ConvexType
}
data ConvexType
- = VString
- | VNumber
- | VInt64
- | VFloat64
- | VBoolean
- | VBytes
- | VNull
- | VAny
- | VId String
- | VArray ConvexType
- | VObject [(String, ConvexType)]
- | VOptional ConvexType
- | VUnion [ConvexType]
- | VLiteral String
- | VReference String
- | VVoid
data ParserState = ParserState {
- psConstants :: Map String ConvexType
}
initialState :: ParserState
getLiteralString :: ConvexType -> String
isLiteral :: ConvexType -> Bool
sanitizeUnionValues :: String -> String

Documentation

parseSchema :: String -> IO (Either ParseError ParsedFile) Source #

data ParsedFile Source #

Constructors

ParsedFile
Fields parsedConstants :: Map String ConvexType parsedSchema :: Schema

Instances

Instances details

Show ParsedFile Source #
Instance details Defined in Convex.Schema.Parser Methods showsPrec :: Int -> ParsedFile -> ShowS # show :: ParsedFile -> String # showList :: [ParsedFile] -> ShowS #
Eq ParsedFile Source #
Instance details Defined in Convex.Schema.Parser Methods (==) :: ParsedFile -> ParsedFile -> Bool # (/=) :: ParsedFile -> ParsedFile -> Bool #

newtype Schema Source #

Constructors

Schema
Fields getTables :: [Table]

Instances

Instances details

Show Schema Source #
Instance details Defined in Convex.Schema.Parser Methods showsPrec :: Int -> Schema -> ShowS # show :: Schema -> String # showList :: [Schema] -> ShowS #
Eq Schema Source #
Instance details Defined in Convex.Schema.Parser Methods (==) :: Schema -> Schema -> Bool # (/=) :: Schema -> Schema -> Bool #

data Table Source #

Constructors

Table
Fields tableName :: String tableFields :: [Field] tableIndexes :: [Index]

Instances

Instances details

Show Table Source #
Instance details Defined in Convex.Schema.Parser Methods showsPrec :: Int -> Table -> ShowS # show :: Table -> String # showList :: [Table] -> ShowS #
Eq Table Source #
Instance details Defined in Convex.Schema.Parser Methods (==) :: Table -> Table -> Bool # (/=) :: Table -> Table -> Bool #

data Index Source #

Constructors

Index
Fields indexName :: String indexFields :: [String]

Instances

Instances details

Show Index Source #
Instance details Defined in Convex.Schema.Parser Methods showsPrec :: Int -> Index -> ShowS # show :: Index -> String # showList :: [Index] -> ShowS #
Eq Index Source #
Instance details Defined in Convex.Schema.Parser Methods (==) :: Index -> Index -> Bool # (/=) :: Index -> Index -> Bool #

data Field Source #

Constructors

Field
Fields fieldName :: String fieldType :: ConvexType

Instances

Instances details

Show Field Source #
Instance details Defined in Convex.Schema.Parser Methods showsPrec :: Int -> Field -> ShowS # show :: Field -> String # showList :: [Field] -> ShowS #
Eq Field Source #
Instance details Defined in Convex.Schema.Parser Methods (==) :: Field -> Field -> Bool # (/=) :: Field -> Field -> Bool #

data ConvexType Source #

Constructors

VString
VNumber
VInt64
VFloat64
VBoolean
VBytes
VNull
VAny
VId String
VArray ConvexType
VObject [(String, ConvexType)]
VOptional ConvexType
VUnion [ConvexType]
VLiteral String
VReference String
VVoid

Instances

Instances details

Show ConvexType Source #
Instance details Defined in Convex.Schema.Parser Methods showsPrec :: Int -> ConvexType -> ShowS # show :: ConvexType -> String # showList :: [ConvexType] -> ShowS #
Eq ConvexType Source #
Instance details Defined in Convex.Schema.Parser Methods (==) :: ConvexType -> ConvexType -> Bool # (/=) :: ConvexType -> ConvexType -> Bool #
Ord ConvexType Source #
Instance details Defined in Convex.Schema.Parser Methods compare :: ConvexType -> ConvexType -> Ordering # (<) :: ConvexType -> ConvexType -> Bool # (<=) :: ConvexType -> ConvexType -> Bool # (>) :: ConvexType -> ConvexType -> Bool # (>=) :: ConvexType -> ConvexType -> Bool # max :: ConvexType -> ConvexType -> ConvexType # min :: ConvexType -> ConvexType -> ConvexType #

data ParserState Source #

Constructors

ParserState
Fields psConstants :: Map String ConvexType

Instances

Instances details

Show ParserState Source #
Instance details Defined in Convex.Schema.Parser Methods showsPrec :: Int -> ParserState -> ShowS # show :: ParserState -> String # showList :: [ParserState] -> ShowS #
Eq ParserState Source #
Instance details Defined in Convex.Schema.Parser Methods (==) :: ParserState -> ParserState -> Bool # (/=) :: ParserState -> ParserState -> Bool #

initialState :: ParserState Source #

getLiteralString :: ConvexType -> String Source #

isLiteral :: ConvexType -> Bool Source #

sanitizeUnionValues :: String -> String Source #

Sanitizes union literals. It might be that a union like this is defined: export const instruction_mime_type = v.union( v.literal("application/pdf"), v.literal("text/html"), v.literal("text/plain") );

And `applicationpdf` would be translated into a type `Applicationpdf`, which is invalid in most languages. After sanitization, it would become application_pdf.