Skip to main content
Version: v3.x

Function Definitions

Now let's fill in some function definitions, these are the functions required to provide to the connector to satisfy the Hasura connector specification, and we'll be implementing them as we go through the course.

Copy and paste the following required functions into the src/index.ts file. Note that the amended connector is also included at the bottom, overwriting the previous connector definition with this which takes these functions as arguments.

async function parseConfiguration(configurationDir: string): Promise<Configuration> {
  throw new Error("Function not implemented.");
}

async function tryInitState(configuration: Configuration, registry: Registry): Promise<State> {
  throw new Error("Function not implemented.");
}

function getCapabilities(configuration: Configuration): CapabilitiesResponse {
  throw new Error("Function not implemented.");
}

async function getSchema(configuration: Configuration): Promise<SchemaResponse> {
  throw new Error("Function not implemented.");
}

async function query(configuration: Configuration, state: State, request: QueryRequest): Promise<QueryResponse> {
  throw new Error("Function not implemented.");
}

async function fetchMetrics(configuration: Configuration, state: State): Promise<undefined> {
  throw new Error("Function not implemented.");
}

async function healthCheck(configuration: Configuration, state: State): Promise<undefined> {
  throw new Error("Function not implemented.");
}

async function queryExplain(
  configuration: Configuration,
  state: State,
  request: QueryRequest,
): Promise<ExplainResponse> {
  throw new Error("Function not implemented.");
}

async function mutationExplain(
  configuration: Configuration,
  state: State,
  request: MutationRequest,
): Promise<ExplainResponse> {
  throw new Error("Function not implemented.");
}

async function mutation(
  configuration: Configuration,
  state: State,
  request: MutationRequest,
): Promise<MutationResponse> {
  throw new Error("Function not implemented.");
}

Now we need to update the connector definition to include these functions.

const connector: Connector<Configuration, State> = {
  parseConfiguration,
  tryInitState,
  getCapabilities,
  getSchema,
  query,
  fetchMetrics,
  healthCheck,
  queryExplain,
  mutationExplain,
  mutation,
};

Ok, moving on swiftly, for this course we will only need to implement the first five functions:

  • parseConfiguration: which reads the configuration from files on disk.
  • tryInitState: which initializes our database connection.
  • getCapabilities: which returns the NDC capabilities of our connector.
  • getSchema: which returns an NDC schema containing our tables and columns.
  • query: which actually responds to query requests.

Let's do that now.

Loading...